# hypnolive

## Up-to-date Hypnospace pages from the internet!

Note: I plan on making this much more user-friendly later.

### Prerequisites
#### Windows
Look, I don't use Windows. I ran from it the second I had a chance. That said, this is the way I remember using Git.

* Hypnospace Outlaw (duh)
* [Git for Windows](https://gitforwindows.org/)

#### Linux

* Hypnospace Outlaw (duh)
* Git (install from your package manager)

### Installation
#### Windows

* Open Git for Windows
* Go to Hypnospace Outlaw's mod folder - Usually C:\Users\[yourusername]\Tendershoot\HypnOS\mods\
* Clone this repository - git clone https://git.innovation-inc.org/Innovation/hypnolive

At this point, the mod will be made available in-game. Start the game!
* Click the "Mods" button on whatever save file you're going to use. Check "Hypnolive"
* Start the save file.

You will immediately have access to the Hypnolive zone. Welcome to Hypnolive!

#### Linux

* Go to Hypnospace Outlaw's mod folder - Usually ~/Tendershoot/HypnOS/mods/
* Clone this repository - git clone https://git.innovation-inc.org/Innovation/hypnolive

At this point, the mod will be made available in-game. Start the game!    
* Click the "Mods" button on whatever save file you're going to use. Check "Hypnolive"
* Start the save file.

You will immediately have access to the Hypnolive zone. Welcome to Hypnolive! 

### Updating
Eventually, this mod will keep itself up to date. However, during this experimental stage, it will require you to update it yourself.

#### Windows

* Open Git for Windows
* Go to Hypnospace Outlaw's mod folder - Usually C:\Users\[yourusername]\Tendershoot\HypnOS\mods\
* Pull the repository - git pull

The pages should automagically refresh when you restart the game.

#### Linux

* Go to Hypnospace Outlaw's mod folder - Usually ~/Tendershoot/HypnOS/mods/
* Pull the repository - git pull 

The pages should automagically refresh when you restart the game.


### Contributing

Want your own Hypnospace pages on Hypnolive? Download the [offical development tools](https://jay-tholen.itch.io/hsps), and start making your own pages.

Fork the repository and make your changes according to the guide below.

Currently, the layout for pages is as follows:
```
hypnolive
|-hs
   |-69_Hypnolive
                |-[your username].hsp  <-- This serves as your main page. Additional pages should be placed in a directory with your username!
                |-[your username]      <-- The rest of your pages should be placed here!
                                |-bluhbluhbluh.hsp
```

When you're happy with your changes, make a pull request. I'll look it over and make sure it doesn't break anyone elses pages, as well as make sure there's nothing that would violate Hypnospace Law.

Later on, when I make a companion app, you'll also be able to add your own repositories if you want to skip the pull request process.