RSDKv4 Decompilation

Une décompilation complète de Retro Engine v4 et des menus de Sonic 1 et 2 (2013).

SOUTENEZ LA SORTIE OFFICIELLE DE SONIC 1 & 2

• Sans les éléments des versions officielles, cette décompilation ne fonctionnera pas.

• Vous pouvez obtenir les versions officielles de Sonic 1 et Sonic 2 auprès de :

  • Fenêtres
    • Via Steam, de Sonic Origins
    • Via l'Epic Games Store, de Sonic Origins
  • IOS
    • Sonic 1, via l'App Store
    • Sonic 2, via l'App Store
    • Un tutoriel pour trouver les ressources du jeu à partir des versions iOS peut être trouvé ici.
  • Androïde
    • Sonic 1, via Google Play
    • Sonic 2, via Google Play
    • Sonic 1, via Amazon
    • Sonic 2, via Amazon
    • Un tutoriel pour trouver les ressources du jeu à partir des versions Android peut être trouvé ici.

Même si votre plate-forme n'est pas prise en charge par les versions officielles, vous devez l'acheter ou la télécharger officiellement pour les ressources (vous n'avez pas besoin d'exécuter la version officielle, vous avez juste besoin des ressources du jeu).

Si vous souhaitez transférer vos sauvegardes à partir de la ou des versions mobiles officielles, le chemin du fichier Android pré-définitif est Android/data/com.sega.sonic1 or 2/SGame.bin (les autres versions peuvent avoir des chemins de fichiers différents ). Copiez ce fichier dans le dossier de décompilation sous le nom SData.bin .

Ajustements supplémentaires

• Ajout du compilateur de script intégré de RSDKv5U.
• Ajout d'un chargeur de mods et d'une API intégrés, permettant de créer et de jouer facilement des mods avec des fonctionnalités telles que la redirection de fichiers de sauvegarde, les réalisations personnalisées et les données XML GameConfig.
• Menu personnalisé et système de mise en réseau pour le multijoueur Sonic 2, permettant à quiconque d'héberger et de rejoindre des serveurs et de jouer à 2P VS.
  • Les serveurs peuvent ne pas être fiables ; cette fonctionnalité est plus ou moins une preuve de concept.
• Egg Gauntlet Zone est jouable dans le menu Time Attack de Sonic 2, si vous utilisez une version du jeu qui l'inclut.
• Il existe désormais un fichier settings.ini que le jeu utilise pour charger tous les paramètres, similaire à Sonic Mania.
• Le menu de développement est désormais accessible de n'importe où en appuyant sur la touche ESC si elle est activée dans la configuration.
• Les fonctionnalités de pause F12 , de passage à niveau F11 et d'avance rapide de Sonic Mania ont toutes été portées et sont activées si devMenu est activé dans la configuration.
• Un certain nombre de fonctionnalités supplémentaires de débogage du menu de développement ont été ajoutées :
  • F1 chargera la première scène de la liste des étapes de présentation (généralement l'écran titre).
  • F2 et F3 chargeront la scène précédente et suivante dans la liste des étapes actuelle.
  • F5 rechargera la scène actuelle, ainsi que tous les éléments et scripts.
  • F8 et F9 visualiseront les hitbox de l’écran tactile et des objets.
  • F10 activera une superposition de palettes qui affichera les 8 palettes internes du jeu en temps réel.
• Ajout de la fonction de gradation de l'écran de veille de Sonic Mania Plus, ainsi que la possibilité pour l'utilisateur de la désactiver ou de définir le temps nécessaire à l'écran pour s'assombrir.

Comment construire

Ce projet utilise CMake, un système de construction polyvalent qui prend en charge de nombreux compilateurs et plates-formes différents. Vous pouvez télécharger CMake ici. (Assurez-vous d'activer la fonctionnalité permettant d'ajouter CMake au PATH du système lors de l'installation !)

Obtenez le code source

Afin de cloner le référentiel, vous devez installer Git, que vous pouvez obtenir ici.

Clonez le dépôt de manière récursive , en utilisant : git clone --recursive https://github.com/RSDKModding/RSDKv4-Decompilation

Si vous avez déjà cloné le dépôt, exécutez cette commande dans le dépôt : git submodule update --init --recursive

Obtenir des dépendances

Fenêtres

Pour gérer les dépendances, vous devrez installer Visual Studio Community (assurez-vous d'installer le package Desktop development with C++ lors de l'installation) et vcpkg (il vous suffit de suivre 1 - Set up vcpkg ).

Après les avoir installés, exécutez ce qui suit dans l'invite de commande (assurez-vous de remplacer [vcpkg root] par le chemin d'accès à l'installation de vcpkg !) :

• [vcpkg root]vcpkg.exe install glew sdl2 libogg libvorbis --triplet=x64-windows-static (Si vous compilez une version 32 bits, remplacez x64-windows-static par x86-windows-static .)

Enfin, suivez les étapes de compilation ci-dessous en utilisant -DCMAKE_TOOLCHAIN_FILE=[vcpkg root]/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-windows-static -DCMAKE_PREFIX_PATH=[vcpkg root]/installed/x64-windows-static/ comme arguments pour cmake -B build .

• Assurez-vous de remplacer chaque instance de [vcpkg root] par le chemin d'accès à l'installation de vcpkg !
• Si vous compilez une version 32 bits, remplacez chaque instance de x64-windows-static par x86-windows-static .

Linux

Installez les dépendances suivantes : puis suivez les étapes de compilation ci-dessous :

• pacman (Arch) : sudo pacman -S base-devel cmake glew sdl2 libogg libvorbis
• apt (Debian/Ubuntu) : sudo apt install build-essential cmake libglew-dev libglfw3-dev libsdl2-dev libogg-dev libvorbis-dev
• rpm (Fedora) : sudo dnf install make gcc cmake glew-devel glfw-devel sdl2-devel libogg-devel libvorbis-devel zlib-devel
• apk (Alpine/PostmarketOS) sudo apk add build-base cmake glew-dev glfw-dev sdl2-dev libogg-dev libvorbis-dev
• Votre gestionnaire de paquets préféré ici, faites une pull request

Androïde

Suivez les instructions de construction Android ici.

Compilation

La compilation est aussi simple que de taper ce qui suit dans le répertoire racine du référentiel :

 cmake -B build
cmake --build build --config release

La version résultante sera située quelque part dans build/ en fonction de votre système.

Les arguments cmake suivants sont disponibles lors de la compilation :

• Utilisez-les en ajoutant -D[flag-name]=[value] à la fin de la commande cmake -B build . Par exemple, pour construire avec RETRO_DISABLE_PLUS activé, ajoutez -DRETRO_DISABLE_PLUS=on à la commande.

Indicateurs RSDKv4

• RETRO_REVISION : Pour quelle révision compiler. Prend un entier, la valeur par défaut est 3 (Origines).
• RETRO_DISABLE_PLUS : Désactiver ou non le DLC Plus. Prend un booléen (on/off) : construit avec on lors de la compilation pour la distribution. La valeur par défaut est off .
• RETRO_FORCE_CASE_INSENSITIVE : Force l'insensibilité à la casse lors du chargement des fichiers. Prend un booléen, par défaut off .
• RETRO_MOD_LOADER : Active ou désactive le chargeur de mod. Prend un booléen, par défaut on .
• RETRO_NETWORKING : Active ou désactive les fonctionnalités réseau utilisées pour le mode 2P VS de Sonic 2. Prend un booléen, par défaut on .
• RETRO_USE_HW_RENDER : active le moteur de rendu matériel utilisé par le menu principal et l'interface utilisateur des commandes tactiles. Prend un booléen, par défaut on .
• RETRO_ORIGINAL_CODE : Supprime tout code personnalisé. Un jeu jouable ne sera pas construit avec cette option activée. Prend un booléen, par défaut off .
• RETRO_SDL_VERSION : modifiez cela uniquement si vous savez ce que vous faites. Bascule entre l’utilisation de SDL1 ou SDL2. Prend un entier de 1 ou 2 , la valeur par défaut est 2 .

Branches non officielles

Suivez les instructions d'installation dans le fichier readme de chaque branche.

• Pour la PlayStation Vita , rendez-vous sur le fork de Xeeynamo.
• Pour la Nintendo Switch , rendez-vous sur le fork de heyjoeway.
• Pour la Nintendo 3DS , rendez-vous sur le fork de JeffRuLz.
  • Une New Nintendo 3DS est requise pour que les jeux fonctionnent correctement.
• Pour y jouer sur le Web en utilisant Wasm , accédez au fork de mattConn.

Étant donné que ces branches ne sont pas officielles, nous ne pouvons pas leur fournir de support et elles peuvent ne pas être à jour.

Autres plateformes

Actuellement, les seules plates-formes prises en charge sont celles répertoriées ci-dessus, mais le backend utilise libogg, libvorbis et SDL2 pour l'alimenter (ainsi que tinyxml2 pour l'API du mod et asio pour la mise en réseau), la base de code est donc très multiplateforme. Si vous le pouvez, vous pouvez cloner ce dépôt et le porter sur une plate-forme ne figurant pas dans la liste.

Serveur

Le serveur multijoueur nécessite Python 3.8 ou version ultérieure. Vous pouvez télécharger Python ici. Pour utiliser le serveur, ouvrez l'invite de commande dans le dossier dans lequel se trouve Server.py, puis exécutez la commande py -3 Server.py [local IPv4 address] [port] debug . Vous pouvez trouver votre adresse IPv4 locale à l'aide de la commande ipconfig . Notez que le serveur C++ trouvé dans le dossier Server est obsolète et ne fonctionne plus. Il a été conservé dans le dépôt à des fins de référence.

FAQ

Vous pouvez trouver la FAQ ici.

Remerciements spéciaux

• st×tic pour m'avoir aidé à corriger des bugs, à peaufiner mon code parfois bâclé et à être généralement très utile et amusant à travailler sur ce projet.
• Le Weigman pour créer l'en-tête que vous voyez ici avec des actifs similaires.
• Tout le monde sur le serveur Retro Engine Modding pour m'avoir soutenu et pour m'avoir donné un endroit où montrer les choses que j'ai trouvées.

Contact:

Rejoignez le serveur Discord Retro Engine Modding pour toute question supplémentaire que vous pourriez avoir besoin de connaître sur la décompilation ou la modification.