the game
docs: add license and readme
+41
-20
+27
LICENSE.md
+27
LICENSE.md
···
1
+
The MIT License (MIT)
2
+
=====================
3
+
4
+
Copyright © `2025` `Kieran Klukas`
5
+
6
+
Permission is hereby granted, free of charge, to any person
7
+
obtaining a copy of this software and associated documentation
8
+
files (the “Software”), to deal in the Software without
9
+
restriction, including without limitation the rights to use,
10
+
copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+
copies of the Software, and to permit persons to whom the
12
+
Software is furnished to do so, subject to the following
13
+
conditions:
14
+
15
+
The above copyright notice and this permission notice shall be
16
+
included in all copies or substantial portions of the Software.
17
+
18
+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
19
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
20
+
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
22
+
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
23
+
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24
+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25
+
OTHER DEALINGS IN THE SOFTWARE.
26
+
27
+
+14
-20
README.md
+14
-20
README.md
···
1
-
# Folder structure
1
+
# Smackdown
2
2
3
-
- `src` - source code for your kaplay project
4
-
- `dist` - distribution folder, contains your index.html, built js bundle and static assets
3
+
A game made for [daydream](https://daydream.hackclub.com/columbus)
5
4
5
+
## Dev notes
6
6
7
-
## Development
7
+
This is bundled with bun and is pretty simple to hack on.
8
8
9
-
```sh
10
-
$ bun run dev
11
-
```
12
-
13
-
will start a dev server at http://localhost:8000
14
-
15
-
## Distribution
16
-
17
-
```sh
18
-
$ bun run build
9
+
```bash
10
+
bun dev # hot reloaded server on localhost
11
+
bun run build # compiles it all to to ./dist
12
+
bun zip # builds it and then zips it to ./dist/game.zip
19
13
```
20
14
21
-
will build your js files into `dist/`
15
+
<p align="center">
16
+
<i><code>© 2025-present <a href="https://github.com/taciturnaxolotl">Kieran Klukas</a></code></i>
17
+
</p>
22
18
23
-
```sh
24
-
$ bun run zip
25
-
```
26
-
27
-
will build your game and package into a .zip file, you can upload to your server or itch.io / newground etc.
19
+
<p align="center">
20
+
<a href="https://github.com/taciturnaxolotl/smackdown/blob/main/LICENSE.md"><img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&logoColor=d9e0ee&colorA=363a4f&colorB=b7bdf8"/></a>
21
+
</p>