Skip to content

Commit

Permalink
Added installation docs
Browse files Browse the repository at this point in the history
  • Loading branch information
peterwilli committed Jan 17, 2022
1 parent 2e755c0 commit fa06b6a
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 3 deletions.
Binary file added Images/compatibility_linux.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Images/local_game_annotation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions Installing your own server.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Installing your own server

TODO
39 changes: 36 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,47 @@ I'm working on a mod called Endless AWSW that will mix the normal AWSW game with

## Installation

This is still in a heavy research and pre-alpha phase. I don't really feel like writing installation docs to software that's likely going to change so heavily. This repo mainly functions for backup keeping for now!
### From source

If you want to help out, please [ping me on my Discord](https://discord.gg/gKcb5U3) (You can also DM me at EmeraldOdin🔒#1991 but sometimes change the name, so it's a gamble hehe)
This tutorial will bring the EAWSW mod to Angels with Scaly Wings. The tutorial focusses on Steam, but it should work with others too.

- **Note for Linux users! (Windows users can ignore this)**: To use mods from Steam workshop, set "force compatibility" to Proton in the properties window.

![Showing game properties where you can set compatibility mode (Linux only)](Images/compatibility_linux.png)

1. Download the [MagmaLink mod](https://steamcommunity.com/sharedfiles/filedetails/?id=2594080243) from the Steam workshop.
2. Find the location of your AWSW installation:
1. On Steam, you can right click your game and click "Browse local files"
![Steam showing the game library, where you right click your game and click "Browse local files"](Images/local_game_annotation.png)
3. Once you opened the folder, browse to `game/mods`-folder.
4. Download [the source from Github](https://github.com/peterwilli/Endless-AWSW/archive/refs/heads/main.zip).
5. Extract the downloaded source, and drop the `EndlessAWSWClient`-folder inside the `mods`-folder.
1. Your final directory should look like this (depending on how much mods you installed, this may vary, as long as you got ~3 subdirectories, where one is called `EndlessAWSWClient` it should be fine):
```
mods/
|-- 2594080243
|-- 2665734102
|-- EndlessAWSWClient
`-- core
```
## How to play!
1. Open the game on Steam.
2. Click "Start" and if you played the game already then make sure to click "no" when the system asks you to skip ahead. You can skip using tab if you like.
3. At some point, Zhong comes along and asks you if you want to play endless or normal mode (it happens the moment Sebastian greets you at your house).
4. Click endless if you want to try this mod, click normal if you want the game to progress as usual.
5. Once you're in endless mode, you can choose a server.
1. For most people, the public server is fine, I'm hosting it for free, and it should be fast enough, depending on how many players are simultaneously playing.
2. If you wish to install your own server, go to [Installing your own server](Installing%20your%20own%20server.md).
6. From here you can select a narrative, and you can type any reply and the dragons will reply in return. Have fun!
If you want to help out, please [ping me on my Discord](https://discord.gg/gKcb5U3) (You can also DM me at EmeraldOdin#1991 but sometimes change the name, so it's a gamble hehe)
## Todo & Bugs
- [x] You can send an empty message
- [ ] Prevent dragons from replying in a loop
- [x] You can send an empty message
- [x] Moving forward in story makes requests to the server (thanks 4onen!)
- [x] Fix RP bug: "Meet Lorem" works but "meet Lorem" doesn't
- [x] Make sure repeated texts are filtered out
Expand Down

0 comments on commit fa06b6a

Please sign in to comment.