Skip to content
/ hypnolive Public
forked from DremOSDeveloperTeam/hypnolive

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

License

MIT license
0 stars 1 fork Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

Dal1ster/hypnolive

BranchesTags
 
 

Repository files navigation

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.

Linux

  • Hypnospace Outlaw (duh)
  • Git (install from your package manager)
  • Python 3.10 or above (install from your package manager)

Installation

Windows

  • Open Git BASH for Windows
  • Go to Hypnospace Outlaw's mod folder in Windows Explorer - Usually C:\Users\[yourusername]\Tendershoot\HypnOS\mods\
  • Right click, and click "Open Open with Git BASH" (or something like that)
  • Clone this repository
    • Run: git clone https://github.com/DremOSDeveloperTeam/hypnolive
  • Change directory to new hypnolive folder
    • Run: cd hypnolive
  • Install dependencies with pip3 install -r requirements.txt

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!

You will now need to configure Hypnolive Companion. Go to the "Configuring the Hypnolive Companion" section for more information.

Linux

NOTE: This assumes you are running the Windows version of Hypnospace Outlaw through Proton. This is necessary if you plan to contribute to Hypnolive!
  • Open a terminal and go to Hypnospace Outlaw's mod folder - Usually ~/Tendershoot/HypnOS/mods/
  • If you use the Steam Flatpak, it'll be ~/.var/app/com.valvesoftware.Steam/.local/share/Steam/steamapps/compatdata/844590/pfx/drive_c/users/steamuser/Tendershoot/mods/
  • Clone this repository
    • Run: git clone https://git.innovation-inc.org/Innovation/hypnolive
  • Change directory to new hypnolive folder
    • Run: cd hypnolive
  • Install dependencies with pip3 install -r requirements.txt

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!

You will now need to configure Hypnolive Companion. Go to the "Configuring the Hypnolive Companion" section for more information.

Updating

This mod keeps itself up to date, but to force an update, you can follow the steps below.

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 HypnOS or 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 HypnOS or the game.

Configuring the Hypnolive Companion

Tutorial

Just Getting the Thing to Work

In order to use the Hypnolive Companion (HC), you must first configure it. The configuration file for HC is companion.ini, in the base folder of the mod.

An example file (companion_example.ini) is provided, and will help you with configuration.

Copy companion_example.ini to companion.ini. You must copy this file, or HC will crash.

Now that you have copied the file. Hypnolive Companion will begin to work. However, weather information will not update, because you need an OpenWeatherMap API key to use it.

Setting up weather

In order to set up weather, you must obtain an OpenWeatherMap API key. To do this, first sign up for an account at OpenWeatherMap's website.

At this point, an API key will be generated for you. You can obtain it at the API Key page.

Copy the key and replace the default APIKey value (under the Weather section) with the key.

Be sure to also change the City value to your city (name only), and set your degree unit.

Note that this will likely not start working immediately, as it takes a while before OpenWeatherMap's API recognizes new keys. This could take hours.

Example Configuration File

; City is the city you reside in.
; DegreeUnit is the degree unit you use - k (kelvin), c (celcius), f (fahrenheit).
; APIKey is your OpenWeatherMap API key - you must get your own.
[Weather]
City=New York City
DegreeUnit=c
APIKey=ATotallyRealAPIKey

; NewsRefresh is the frequency in seconds in which news will refresh when running as a daemon.
; WeatherRefresh is the frequency in seconds in which weather will refresh when running as a daemon.
; PageRefresh is the frequency in seconds in which updated pages will be pulled from the repository.
[Daemon]
NewsRefresh=3600
WeatherRefresh=1800
PageRefresh=1800

; Commits is the RSS feed for the Hypnolive repository.
; Feeds is a list of your RSS feeds, separated by SPACES.
[RSS]
Commits=https://github.com/DremOSDeveloperTeam/hypnolive/commits.atom
Feeds=https://www.pine64.org/feed/

Automatically Starting the Script

It may be more convenient to start the companion script when your computer starts. Here's how to do that.

Windows

I forgot how Windows services work...

Linux

  • Create a new user systemd service file at /etc/systemd/user
  • $ nano $HOME/.config/systemd/user/hypnolive-companion.service
  • Write the following text file (with appropriate changes):
[Unit]
Description=Hypnolive Companion
After=multi-user.target

[Service]
Type=simple
Restart=always
WorkingDirectory=/path/to/mods/hypnolive/
ExecStart=/usr/bin/python3 /path/to/companion.py -d

[Install]
WantedBy=multi-user.target

So, for most Non-Flatpak Installs:

[Unit]
Description=Hypnolive Companion
After=multi-user.target

[Service]
Type=simple
Restart=always
WorkingDirectory=%h/Tendershoot/HypnOS/mods/hypnolive/
ExecStart=/usr/bin/python3 %h/Tendershoot/HypnOS/mods/hypnolive/companion.py -d

[Install]
WantedBy=multi-user.target

And most Flatpak Installs:

[Unit]
Description=Hypnolive Companion
After=multi-user.target

[Service]
Type=simple
Restart=always
WorkingDirectory=%h/.var/app/com.valvesoftware.Steam/.local/share/Steam/steamapps/compatdata/844590/pfx/drive_c/users/steamuser/Tendershoot/HypnOS/mods/hypnolive/
ExecStart=/usr/bin/python3 %h/.var/app/com.valvesoftware.Steam/.local/share/Steam/steamapps/compatdata/844590/pfx/drive_c/users/steamuser/Tendershoot/HypnOS/mods/hypnolive/companion.py -d

[Install]
WantedBy=multi-user.target

You may now start your new service with systemctl --user status hypnolive-companion.service, and make it start on bootup with systemctl --user enable hypnolive-companion.service.

Contributing

Want your own Hypnospace pages on Hypnolive? Download the offical development tools, 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.

About

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

Resources

Readme

License

MIT license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%