Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/remarkablegames/linkit
🔴 Linkit is a puzzle where you connect the dots
https://github.com/remarkablegames/linkit
game html html5 javascript phaser puzzle puzzle-game puzzles typescript web
Last synced: 2 months ago
JSON representation
🔴 Linkit is a puzzle where you connect the dots
- Host: GitHub
- URL: https://github.com/remarkablegames/linkit
- Owner: remarkablegames
- License: mit
- Created: 2024-04-21T18:20:47.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-09-29T06:18:48.000Z (3 months ago)
- Last Synced: 2024-09-29T23:35:40.729Z (3 months ago)
- Topics: game, html, html5, javascript, phaser, puzzle, puzzle-game, puzzles, typescript, web
- Language: TypeScript
- Homepage: https://remarkablegames.org/linkit
- Size: 1.2 MB
- Stars: 2
- Watchers: 0
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Linkit
[](https://github.com/remarkablegames/linkit/actions/workflows/build.yml)
🔴 Linkit is a puzzle where you connect the dots. Read the [blog post](https://remarkablegames.org/posts/linkit/).
This game was made for [Gamedev.js Jam 2024](https://itch.io/jam/gamedevjs-2024), which the theme was `power`.
Play the game on:
- [remarkablegames](https://remarkablegames.org/linkit/)
- [itch.io](https://remarkablegames.itch.io/linkit)
- [Newgrounds](https://www.newgrounds.com/portal/view/930960)
## Credits
- [remarkablemark](https://github.com/remarkablemark) - Developer
- [Rob Cohen](https://github.com/rmacohen) - Level Design
- [Kenney Interface Sounds](https://kenney.nl/assets/interface-sounds)
## Ideation
- [Excalidraw](https://excalidraw.com/#json=kdRfqSm9UoL0cEQ8MPRNo,mMrxHx-OPwRogYySd-1PqQ)
- [Replit](https://replit.com/@remarkablemark/Linkit)
## Prerequisites
- [nvm](https://github.com/nvm-sh/nvm#readme)
## Install
Clone the repository:
```sh
git clone https://github.com/remarkablegames/linkit.git
cd linkit
```
Install the dependencies:
```sh
npm install
```
## Environment Variables
Set the environment variables:
```sh
less .env
```
Update the **Secrets** in the repository **Settings**.
## Available Scripts
In the project directory, you can run:
### `npm start`
Runs the game in the development mode.
Open [http://localhost:5173](http://localhost:5173) to view it in the browser.
The page will reload if you make edits.
You will also see any errors in the console.
### `npm run build`
Builds the game for production to the `dist` folder.
It correctly bundles in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your game is ready to be deployed!
### `npm run bundle`
Builds the game and packages it into a Zip file in the `dist` folder.
Your game can be uploaded to your server, [Itch.io](https://itch.io/), [Newgrounds](https://www.newgrounds.com/), etc.
### `npm run generate-level`
Randomly generates a level.
> [!NOTE]
> Make sure to playtest the level by appending `?level=` to the URL.
#### Examples
2x2 grid that is filled 100% with 1 color:
```sh
npm run generate-level -- --columns=2 --rows=2 --colors=1 --fill=1
```
Output:
```js
[
[M, M],
[M, M],
];
```
4x4 grid that is filled 50% with 2 colors:
```sh
npm run generate-level -- --columns=4 --rows=4 --colors=2 --fill=.5
```
Output:
```js
[
[_, _, M, M],
[_, Y, M, Y],
[M, _, _, _],
[Y, _, M, _],
];
```
## License
[MIT](LICENSE)