etc/SuperMarioOdysseyOnline
0
0
Fork 0
mirror of https://github.com/CraftyBoss/SuperMarioOdysseyOnline.git synced 2024-11-21 10:45:14 +00:00
Code Issues Projects Releases Wiki Activity

Simplify the readme for the average user and direct to website

Browse source
This commit is contained in:
Jack Garrard 2023-09-11 00:28:32 -07:00
parent 83a1d70e01
commit d0dfb63519
1 changed files with 25 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

70
README.md
View file

@ -10,65 +10,45 @@ Welcome to the official repository for the Super Mario Odyssey Online mod! Have
* Moon Collection is shared between all players
* Custom Configuration Menu (Accessible by holding ZL and selecting any option in the pause/start menu)
* Support for custom gamemodes (WIP)
### Available Gamemodes
* Hide and Seek
## SMO Version Support
## Installation and Usage
For the typical installation along with how to setup and use muliplayer/hide and seek, please visit the [Super Mario Odyssey website](https://smoo.it).
* 1.0
<details>
## Installation
The following instructions are not through and complete as the website, as such please visit the [Super Mario Odyssey website](https://smoo.it). The old instructions are listed below for documentation sake. If you're having any trouble or issues, please make sure you've checked through the website.
<summary>Developer build instructions</summary>
## Installation Tutorial [DEPRECATED]
Before installing, Ensure that your switch is hacked. If not, follow [This Guide](https://switch.homebrew.guide/) to get your switch setup for modding. Make sure you set up a way to block Nintendo's servers as you will need to have your switch connected to the internet for this mod to work!
### Building Prerequisites
1. Download the latest mod build from either [Gamebanana](https://gamebanana.com/mods/384214) or from the [Releases](https://github.com/CraftyBoss/SuperMarioOdysseyOnline/releases) tab. (Alternatively, build from source)
2. Extract the downloaded zip onto the root of your Switch's SD card.
3. If you need to host an online server, head over to the [Super Mario Odyssey Online Server](https://github.com/Sanae6/SmoOnlineServer) repository and follow the instructions there to set up the server.
4. Launch the game! Upon first time bootup, the mod should ask for a server IP to save to the games common save file. This IP address will be the server you wish to connect to every time you launch the game with the mod installed. (Note: un-installing the mod and launching the game will remove the server IP from the common save file.)
- [devkitPro](https://devkitpro.org/)
- Python 3
- The [Keystone-Engine](https://www.keystone-engine.org/) Python Module
## Gamemode Info
### Hide and Seek
* Depending on Group size, select who will start as seekers at the beginning of each round and a kingdom to hide in.
* Each player has a timer on the top right of the screen that will increase while they are hiding during a round.
* When a seeker gets close enough to a player, the player will die and respawn as a seeker.
* During the round, hiders who die by other means will also become seekers upon respawning.
* If a hider loads into a new stage (via a pipe, door, etc.) the hider will get 5 seconds of tag invincibility to prevent spawn point camping.
* The player with the most time at the end of a round (or set of rounds) is considered the winner.
* While not a concrete rule, it's generally agreed upon that hiding should not be done out of bounds, inside objects that don't sync across games yet, and inside objects that completely conceal a player from others (such as trees).
### Building
## Gamemode Controls
### Hide and Seek
- Left D-Pad: Decrease time
- Right D-Pad: Increase Time
- L + D-Pad Down: Reset Time
- D-Pad Up: Switch from Hider/Seeker
Build has only been tested on WSL2 running Ubuntu 20.04.1.
## Building Prerequisites
Just run:
```
DEVKITPRO={path_to_devkitpro} make
```
- [devkitPro](https://devkitpro.org/)
- Python 3
- The [Keystone-Engine](https://www.keystone-engine.org/) Python Module
On Ubuntu (and other Debian-based systems), devkitPro will be installed to `/opt/devkitpro` by default:
## Building
```
DEVKITPRO=/opt/devkitpro/ make
```
Build has only been tested on WSL2 running Ubuntu 20.04.1.
### Installing (Atmosphère)
Just run:
```
DEVKITPRO={path_to_devkitpro} make
```
After a successful build, simply transfer the `atmosphere` folder located inside `starlight_patch_100` to the root of your switch's SD card.
</details>
On Ubuntu (and other Debian-based systems), devkitPro will be installed to `/opt/devkitpro` by default:
## Troubleshooting
```
DEVKITPRO=/opt/devkitpro/ make
```
## Installing (Atmosphère)
After a successful build, simply transfer the `atmosphere` folder located inside `starlight_patch_100` to the root of your switch's SD card.
The [Super Mario Odyssey website](https://smoo.it) has a FAQ section that should solve many issues.
However, for any further questions or help not covered by the site, please visit the [CraftyBoss Community Discord Server](discord.gg/jYCueK2BqD) and ask in the `help`/`help-2` channel.
---