diff --git a/README.md b/README.md index c4814182..426ab3f7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,28 @@ -# Render96ex -Fork of [sm64ex](https://github.com/sm64pc/sm64ex) +# Saturn (dev) -This is meant to be a fork where the team can upload their code. -If you want to help sm64ex then go to their repo. -If you want to help us out then message me on discord DorfDork#4516 +- Saturn (dev) is a fork of [Undervolt/Moon64](https://github.com/Undervolt/Moon64) with machinima features. +- In order to compile the editor, a prior copy of the game is required. This is to avoid including any copyrighted material. + +#### Features + +- Freeze camera, works in any level +- Color code editor + - Uses the common *GameShark* format +- Changeable eye/hand/cap states +- Custom textures (& texture packs) support + - All textures, including those used in the eye states, are 100% customizable +- Settings manager +- Completely revamped UI with dockable panels + +## Installation + +For building instructions, please refer to the [wiki](https://github.com/Llennpie/Saturn/wiki).
+Saturn currently supports Windows ([MSYS2](https://www.msys2.org/)) and Linux. + +*See [here](https://github.com/sm64pc/sm64ex/wiki) for other untested build platforms. These may require source code modifications.* + +![Screenshot](https://media.discordapp.net/attachments/833759041096384573/895822644782448690/screenshot.png?width=960&height=599) + +*In case you feel this project deserves some extra love, I have a Ko-fi below.* + +[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/J3J05B5WR)