Update README.md

This commit is contained in:
Llennpie 2021-12-30 20:47:55 -05:00 committed by GitHub
parent d2d546ea75
commit 2ce8fd7441
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 5 deletions

View File

@ -1,7 +1,8 @@
# Saturn: Moon Edition
- *Saturn: Moon Edition* is a fork of [Undervolt/Moon64](https://github.com/Undervolt/Moon64) with machinima features.
- In order to use or compile the editor, a prior copy of the game is required. This is to avoid including any copyrighted material.
- *Saturn: Moon Edition* is a cross-platform all-in-one machinima studio for *Super Mario 64*, based on [Undervolt/Moon64](https://github.com/Undervolt/Moon64).
- In order to download, use or compile the editor, a prior copy of the game is required. This is to avoid including any copyrighted assets or material.
- *Detailed, extensive guides can be found on our [wiki](https://github.com/Llennpie/Saturn/wiki).*
#### Features
@ -16,15 +17,23 @@
- Uses the common *GameShark* format
- Complete visual CC editor
- Color presets save as a .gs file for later use
- Chroma Key Stage
- Background is color-changeable to any RGB/Hex code
- Animation Player
- Can play all 209 of Mario's in-game animations
- Supports looping/first-person to move head
- Toggles for HUD, Mario's cap emblem, overall buttons, voices, head rotations, shadows, dust particles and more
- Switch between cap states (on/off/wing) and hand poses (victory/open/holding hat/etc.)
- Warp to any level from the menu
- Custom textures (& texture packs) support
- All textures are 100% customizable
- Settings manager
- All options from sm64ex and Moon64 (minus configuring controls, currently) carry over to the new UI
- Option to disable music and Mario's voice for machinima purposes
- Addons Menu, to switch priority/order of texture packs & more
- "Anti-aliasing" (not really, just clever internal resolution scaling, works better with cross-platform)
- "Jabo Mode", a toggle to recreate the infamous weird widescreen stretching, as seen in many Project64 graphics plugins.
- "Wireframe Mode", it just looks really cool...
```
*... And more to come!*
@ -35,14 +44,17 @@
To download *Moon Edition*, follow these instructions:
- Install the latest release from the [releases](https://github.com/Llennpie/Saturn/releases) page.
- Head to [this website](http://moon64.undervolt.io/addons) and download the **Moon64 Default Addon**. You will need a vanilla 8 MB ROM to continue *(this is to avoid including any copyrighted assets)*.
- Head to the [Moon64 Addons](http://moon64.undervolt.io/addons) website and download the **Moon64 Default Addon**. You will need a vanilla 8 MB ROM to continue *(this is to avoid including any copyrighted assets)*.
- Place the `moon64.bit` file into `addons/`, next to the `saturn/` folder **(but not in)**. Upon launching the game for the first time, it may take a second to extract assets.
- *Optionally, get a [120 star savefile](https://cdn.discordapp.com/attachments/814630624920076298/915021206888001566/Moon64-Save-1.dat) and place in* `%appdata%/SaturnME` *(or* `.local/share/SaturnME` *on Linux).*
### Compiling
### Compiling from Source
- For building instructions, please refer to the [wiki](https://github.com/Llennpie/Saturn/wiki).
![Screenshot](https://cdn.discordapp.com/attachments/863117129347891251/903456042141249566/unknown.png)
***
![Screenshot](https://cdn.discordapp.com/attachments/833759041096384573/926286368877985803/FHoub4CWUAEeyFQ.png)
*In case you feel this project deserves some extra love, I have a Ko-fi below.*