|
| 1 | +# Installation |
| 2 | + |
| 3 | +## Userscript Manager (recommended) |
| 4 | + |
| 5 | +!!! hint |
| 6 | + |
| 7 | + If you don't have a userscript manager yet, [Tampermonkey](https://www.tampermonkey.net/) is a good solution for the most popular browsers. |
| 8 | + |
| 9 | +The file you need to put into your userscript manager is available from the [Releases page](https://github.com/kitten-science/kitten-scientists/releases) of KS. |
| 10 | + |
| 11 | +KS is released in 3 variants: |
| 12 | + |
| 13 | +1. The **latest** release. |
| 14 | + |
| 15 | + This is a release with a familiar version number, that has been designated as a reasonably stable version to use. At this time, that is: |
| 16 | + |
| 17 | + <https://github.com/kitten-science/kitten-scientists/releases/tag/v2.0.0-beta.1>. |
| 18 | + |
| 19 | +1. The **nightly** release. |
| 20 | + |
| 21 | + This release is built each night, if any changes have been made to the source code since the last nightly build. |
| 22 | + |
| 23 | + These builds usually have a time stamp in their filename, like `20230103`, which designates the night they were built on. |
| 24 | + |
| 25 | + <https://github.com/kitten-science/kitten-scientists/releases/tag/nightly> |
| 26 | + |
| 27 | +1. The **latest** release. |
| 28 | + |
| 29 | + This is built after every single change to the codebase. It should be considered highly unstable and experimental, although it usually isn't. |
| 30 | + |
| 31 | + <https://github.com/kitten-science/kitten-scientists/releases/tag/latest> |
| 32 | + |
| 33 | +## Bookmarklet |
| 34 | + |
| 35 | +You can also load KS through a bookmarklet. |
| 36 | + |
| 37 | +To use bookmarklets, just create a new bookmark in your browser and enter the text below as the URL. When you're on the KG game website, open this bookmark, and it should KS for you. |
| 38 | + |
| 39 | +!!! note |
| 40 | + |
| 41 | + This bookmarklet points to the **latest** release of KS. |
| 42 | + |
| 43 | +``` |
| 44 | +javascript:(function(){var d=document,s=d.createElement('script');s.src='https://github.com/kitten-science/kitten-scientists/releases/download/v2.0.0-beta.1/kitten-scientists-2.0.0-beta.1.user.js';d.body.appendChild(s);})(); |
| 45 | +``` |
| 46 | + |
| 47 | +## Container |
| 48 | + |
| 49 | +!!! warning |
| 50 | + |
| 51 | + If you are not familiar with Docker/OCI containers, then you can safely ignore this section. |
| 52 | + |
| 53 | +You can pull any version of the script as a container. The images are hosted on the [GitHub registry](https://github.com/kitten-science/kitten-scientists/pkgs/container/kitten-scientists). |
| 54 | + |
| 55 | +The container exposes Kittens Game's own development server on port 8080. It has the version of the userscript injected into it, according to the tag on the image. |
| 56 | + |
| 57 | +```shell |
| 58 | +docker run --publish 8080:8080 --rm ghcr.io/kitten-science/kitten-scientists:2.0.0-beta.1 |
| 59 | +``` |
| 60 | + |
| 61 | +<!-- prettier-ignore-start --> |
| 62 | +*[KG]: Kittens Game |
| 63 | +*[KS]: Kitten Scientists |
| 64 | +*[UI]: User interface |
| 65 | +<!-- prettier-ignore-end --> |
0 commit comments