diff --git a/README.md b/README.md new file mode 100644 index 000000000..31e8451fa --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +## Thank you for downloading Pokémon Infinite Fusion! + +Playing the game +--- +**Windows** + +Use **Game.exe** to play the game. That's it! + +If you are experiencing issues such as long loading times, you can also try Game-performance.exe. + +----- +**MacOS / Linux** + +The game is not made to run natively on anything other than Windows. However, it is possible to play it Mac and Linux using Wine or Whiskey. + +Refer to these tutorials: + +[Wine install guide](https://hackmd.io/@PIF-Tech/MacWineGuide) + +[Whiskey install guide](https://hackmd.io/@PIF-Tech/MacWhiskeyGuide) + + +Once Wine is installed on your computer, you can use "launch-wine.sh" to launch the game. + +--- +**Android** + +To play Infinite Fusion on Android, you need to use a RPG Maker emulator called [JoiPlay](https://joiplay.net/). + +[Android setup guide](https://hackmd.io/@PIF-Tech/AndroidGuide) + +--- +## Contributing to the game + +Pokémon Infinite Fusion is open-source! All of the game's code is located in the Data/Scripts folder. + +We accept pull requests for bug fixes and minor features* (Please contact chardub on the game's Discord if you have a feature idea to get it pre-approved before you start working on it!) + +**Note: Any pull request that modifies the RPG Maker files outside of the Scripts folder will be automatically denied. +This includes any changes to the maps/game events. The reason for this is that unfortunately, the way RPG Maker XP's data +files are structured does not allow to easily see what the changes made are.** + +To contribute: + +- Fork the game's repo from https://github.com/infinitefusion/infinitefusion-e18 +- Work from the **develop** branch to avoid merge conflicts +- Open a pull request once you're done to merge into **develop**. A pull request should only contain a single feature or bug fix. Any PR that bundles multiple features/fixes will be denied. + +**There is no guarantee that submitted pull requests will be accepted.* + +--- +## Useful links: +- [Wiki](https://infinitefusion.fandom.com/) +- [Discord](https://discord.gg/infinitefusion) +- [Reddit](https://www.reddit.com/r/PokemonInfiniteFusion/) +- [Pokecommunity](https://www.pokecommunity.com/showthread.php?t=347883) +- [Showdown](http://play.pokeathlon.com) +- [Fusion calculator](https://www.fusiondex.org/) + +This is a free-to-play Pokémon fan game. If you paid any amount of money to play this game, you have been scammed. +This game is not affiliated with Nintendo, Game Freak or Creatures Inc. \ No newline at end of file diff --git a/readme.txt b/readme.txt deleted file mode 100644 index 0cd5c3acc..000000000 --- a/readme.txt +++ /dev/null @@ -1,16 +0,0 @@ -Thank you for downloading Pok?mon Infinite Fusion! - -Use Game.exe to play the game. -If you are experiencing issues such as long loading times, you can also try the alternate launcher. - - -Useful links: -Wiki: https://infinitefusion.fandom.com/ -Discord: https://discord.gg/infinitefusion -Reddit: https://www.reddit.com/r/PokemonInfiniteFusion/ -Pokecommunity https://www.pokecommunity.com/showthread.php?t=347883 -Showdown play.pokeathlon.com -Fusion calculator https://www.fusiondex.org/ - -This is a free-to-play Pok?mon fan game. If you paid any amount of money to play this game, you have been scammed. -This game is not affiliated with Nintendo, Game Freak or Creatures Inc. \ No newline at end of file