faraphel / atlas-install

A program to simplify the creation and installation of mario kart wii mods

MKWFaraphel Installateur / MKWF Installer

Français

Cet outil vous permet d'installer Mario Kart Wii Faraphel sans avoir à modifier tous les fichiers 1 par 1. Pour plus d'information, vous pouvez regarder le wiki du projet ou rejoindre le discord du mod.

Prérequis

• Une ROM de Mario Kart Wii dumpé depuis votre console avec votre propre copie (en CISO, ISO, WBFS, FST (Dossier))
• L'installateur disponible dans https://github.com/Faraphel/MKWF-Install/releases -> MKWF.vX.X.zip en .exe, ou utiliser la source si vous avez python 3.8 et la librairie requests ainsi que pillow

Installations

• Lancer l'application MKWF-Install.exe / MKWF-Install.py
• Sélectionner la ROM de votre jeu
• Appuyez sur "Extraire le fichier", qui va copier votre jeu dans un dossier nommé MKWiiFaraphel
• Une fois le fichier extrait, appuyez sur "Préparer les fichiers", cela va convertir beaucoup de fichiers, comprenant les textes, les textures, les fichiers des menus, certains items et les courses. Cela peut prendre un certains temps (environ 15min). Cette opération n'a besoin d'être faite qu'une seule fois
• Une fois les fichiers prêt, vous pouvez choisir le format de sortie du jeu (ISO, CISO, WBFS, FST (Dossier)) et appuyez sur "Installer le mod". Après cette opération, une notification va apparaître vous informant que l'installation est terminée

Une fois cela fait, vous pouvez lancer votre jeu avec Dolphin ou depuis votre Wii avec un Homebrew. L'ID du jeu est RMCP60 si vous n'avez pas choisi comme format de sortie FST.

Si vous rencontrez un problème avec l'installateur, envoyez-moi un mp sur discord à Faraphel#4526

English

This tools allow you to install Mario Kart Wii Faraphel without having to edit each file manually. For more information, you can look at the wiki or join the mod's discord

Prérequis

• A Mario Kart Wii file dump from your own console with your own copie (in CISO, ISO, WBFS, FST (Directory))
• The installer available in https://github.com/Faraphel/MKWF-Install/releases -> MKWF.vX.X.zip in .exe, or you can use the source if you have python 3.8, requests and pillow.

Installations

• start MKWF-Install.exe / MKWF-Install.py
• Select game file
• Press "Extract file", that'll extract the game in a directory named MKWiiFaraphel
• Once the file extracted, press "Prepare files". This is going to convert many files, including texts, textures, menus files, items and tracks. This can take a while (approximately 15min). This only need to be done one time.
• Once files are ready, you can choose the game extension output (ISO, CISO, WBFS, FST (Directory)) and press "Install mod". Once the mod is installed, a notification will appear.

You can now play the game with Dolphin, or on your Wii with a Homebrew. The game ID is RMCP60 if output format isn't FST.

If you find a problem with the program, please contact me on discord at Faraphel#4526

atlas-install's Issues

Migrate to C++

The current program is written in Python, which is one of the slowest language to profit the easier syntax, module, structure, development speed, and allowed the safe_eval system to work due to the eval function.
C++ would be a perfect alternative due to its speed, the structure and the libraries, despite being way harder to debug and write.

Experiment with a block or a node system to replace the older "safe_eval" system

The project need to allow the mods creators to write their own logic describing how to patch a file. The current system use a subset of Python (named "safe_eval" in the project) that try to avoid as much dangerous instructions as possible, but might be flawed due to its nature.
To avoid this issue, this system will be replaced either by a block system (similar to Scratch or Blocky), or a node system (similar to the one available in Blender), that would be way more beginner-friendly and would avoid many security risk for the users.