Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
whos-evan authored Jan 13, 2023
1 parent 1ac51e0 commit 5fb71aa
Showing 1 changed file with 3 additions and 86 deletions.
89 changes: 3 additions & 86 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,98 +8,15 @@ For support the fastest way to contact us is through Discord. Join our Discord s

## Installation

Support for self-hosting will be coming soon!
Check out our [wiki](https://github.com/whos-evan/kazwire/wiki) for information about self-hosting!

## Run Locally (for developement purposes)

The proxy part of Kazwire will not work if you only do the following steps. (Support for that is coming soon!)
Install Node.js and NPM
Clone the repository with

```bash
git clone https://github.com/whos-evan/kazwire.git
```

Set the active directory to the cloned repository.

```bash
cd kazwire
```

Edit `uv.config.js` in the `./static/uv` folder to a working bare-server (e.g. `https://search.kazwire.com/bare/`).

```bash
nano static/uv/uv.config.js
```

Install the necessary packages using npm, build it, and run it.

```bash
npm install
npm run dev
```

## Adding games

We have a games.json file located [here](https://github.com/whos-evan/kazwire/blob/master/src/routes/games/games.json) which you can edit to add your favorite games!

### Formatting of the games.json file

Example of the formatting

```json
{
"games": [
{
"description": "Description of the game",
"developer": "Developer of the game",
"id": "id-of-the-game",
"image": "id-of-the-game.png",
"name": "Title Case: Name of the Game",
"releaseDate": "?",
"embedURL": "https://urlofthegame.tld",
"popular": true,
"emulator": "ruffle"
}
]
}
```

`description`: Full description of the game, not too long or short.

`developer`: Ensure to give credit to everyone necessary.

`id`: Ensure that there are no spaces and that everything is lowercase.

`image`: This will grab the image from the `./static/game/img` folder, the filename should match the `id`.

`name`: The name that will be shown to the user. Usually in title case.

`releaseDate`: May be used in the future for now it is usually `?`.

`embedURL`: If the game is only accessible through a proxy then include the URL that should be proxied.

`popular`: Boolean (either `true` or `false`). Applies only if the game is popular or not.

`emulator`: Can either be ruffle or emulatorjs. If it is ruffle then there only needs to be the `swf` file in `./static/game/[id-of-game]/[id-of-game].swf` otherwise the necessary files (`index.html`, etc.) must be included in the `./static/game/[id-of-game]/[id-of-game].swf` folder.

### Other information:

- If the game has static assets (i.e. it isn't proxied) then the necessary files must be placed in the `./static/game/[id-of-game]` folder along with an `index.html` file.
- An image must be placed in the `./static/game/img` directory that matches the image provided in the json file.
## Development
Check out our [wiki](https://github.com/whos-evan/kazwire/wiki) for development instructions and help.

## Roadmap

- Better self-hosting support!

- Docker support for easy deployment.
- Possibly support for Railway and other PaaS providers.
- Removal of the `ad block disable` message for users who selfhosting.

- Splitting of games assets and website code with different repositories.

- Add a wiki for adding games and modifying the site.

## Screenshots!

![brave_Jl0NzV94ME](https://user-images.githubusercontent.com/72959444/209419997-4a995a17-1b1d-4b21-b9ef-f19c10d3c0d8.png)
Expand Down

0 comments on commit 5fb71aa

Please sign in to comment.