Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/remarkablegames/lights-out
💡 Lights Out is a game where you collect the power-ups
https://github.com/remarkablegames/lights-out
2d game html javascript phaser typescript web
Last synced: about 18 hours ago
JSON representation
💡 Lights Out is a game where you collect the power-ups
- Host: GitHub
- URL: https://github.com/remarkablegames/lights-out
- Owner: remarkablegames
- License: mit
- Created: 2024-04-13T16:06:42.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-04-26T03:47:17.000Z (5 months ago)
- Last Synced: 2024-04-26T04:27:57.649Z (5 months ago)
- Topics: 2d, game, html, javascript, phaser, typescript, web
- Language: TypeScript
- Homepage: https://remarkablegames.org/lights-out
- Size: 4.85 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Lights Out
[](https://github.com/remarkablegames/lights-out/actions/workflows/build.yml)
💡 Lights Out is a game where you collect power-ups.
This game was made for [Gamedev.js Jam 2024](https://itch.io/jam/gamedevjs-2024), in which the theme was `power`.
Play the game on:
- [remarkablegames](https://remarkablegames.org/lights-out)
- [itch.io](https://remarkablegames.itch.io/lights-out)
## Ideation
- [Excalidraw](https://excalidraw.com/#json=kdRfqSm9UoL0cEQ8MPRNo,mMrxHx-OPwRogYySd-1PqQ)
## Prerequisites
- [nvm](https://github.com/nvm-sh/nvm#readme)
## Install
Clone the repository:
```sh
git clone https://github.com/remarkablegames/lights-out.git
cd lights-out
```
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.
## License
[MIT](LICENSE)