Skip to content

Commit

Permalink
update the guide
Browse files Browse the repository at this point in the history
  • Loading branch information
nhaar committed Oct 5, 2024
1 parent ba4a50a commit 2d555e3
Showing 1 changed file with 6 additions and 12 deletions.
18 changes: 6 additions & 12 deletions guide/GUIDE.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# How to play Waddle Forever

1. Download the latest version [here](https://github.com/nhaar/Waddle-Forever/releases/latest). In the "Assets" section, click the .zip to download it:
1. Download the latest version [here](https://github.com/nhaar/Waddle-Forever/releases/latest). In the "Assets" section, click the .zip to download it (Choose your version, windows or linux, only 64-bits supported):

![Download](./download.png)

2. Extract the folder

3. Open inside `WaddleForeverClient.exe`. You will likely be warned by computer/antivirus, but you can accept everything as there is no risk in using this program.
3. Open `WaddleForeverClient`. You will likely be warned by computer/antivirus, but you can accept everything as there is no risk in using this program.

4. Enjoy!

Expand All @@ -21,7 +21,7 @@ You don't create accounts, all you need to do is to login with the name you want

Instead of using the built-in client, you can play in browser or flash projector if that is better for you.

1. In the Waddle Forever folder, there is a file called `WaddleForeverServer.exe`. Open it and a command prompt will show up. This means the game is running.
1. In the Waddle Forever folder, there is a file called `WaddleForeverServer`. Open it and a command prompt will show up. This means the game is running.

2. For browser, go to `http://localhost/` to play. For Flash Projector, go to `http://localhost/boots.swf`.

Expand All @@ -35,17 +35,11 @@ Two commands you should use for speedruns:

# Settings

Currently, the only way to edit settings is to do it manually. In future updates, you will be able to do this from inside the client.
Inside the client, you may edit the settings clicking Options -> Settings. Current settings:

After you play the game once, a file called `settings.toml` will appear. You can open the file and change the settings. Currently, two settings are available:
* 30 FPS: If enabled, the game will be 30 FPS, need to reload and clear cache.

- `30fps`, set to `true` if you want to play in 30 FPS.
- `thin_ice_igt`, set to `true` to use the Thin Ice IGT mod.

> [!WARNING]
> The Thin Ice IGT mod only works for 30 FPS.
You will need to restart the client or server everytime you make a settings change.
* Thin Ice IGT: Add speedrun timer to Thin Ice. Need to clear cache to enable.

> [!WARNING]
> Making changes in Flash Player requires you to clear cache. In the client you can do that easily in the menu, and it's usually easy for browsers too.
Expand Down

0 comments on commit 2d555e3

Please sign in to comment.