vrmiguel
/
sm64pc
mirror of https://github.com/sm64pc/sm64pc.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Update README.md

This commit is contained in:
Llennpie 2021-11-29 17:31:04 -05:00 committed by GitHub
parent eeb8b8a202
commit 8e4561ed5c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -1,25 +1,46 @@
# Saturn (dev)
# Saturn: Moon Edition
- 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.
- *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.
#### Features
- Freeze camera, works in any level
```
- Completely revamped UI with dockable panels
- Machinima camera
- A "free camera", can be frozen in place or moved with the joystick.
- Custom eye textures
- Loaded externally as PNG files
- Can be selected through a dropdown
- Color code editor
- Uses the common *GameShark* format
- Changeable eye/hand/cap states
- Complete visual CC editor
- Color presets save as a .gs file for later use
- 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.)
- Custom textures (& texture packs) support
- All textures, including those used in the eye states, are 100% customizable
- All textures are 100% customizable
- Settings manager
- Completely revamped UI with dockable panels
- 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
- "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.
```
*... And more to come!*
## Installation
For building instructions, please refer to the [wiki](https://github.com/Llennpie/Saturn/wiki).<br>
Saturn currently supports Windows ([MSYS2](https://www.msys2.org/)) and Linux.
### Download (recommended)
*See [here](https://github.com/sm64pc/sm64ex/wiki) for other untested build platforms. These may require source code modifications.*
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).
- Please 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.
### Compiling
- For building instructions, please refer to the [wiki](https://github.com/Llennpie/Saturn/wiki).
![Screenshot](https://cdn.discordapp.com/attachments/863117129347891251/903456042141249566/unknown.png)