A small game made for KaiOS devices, available in the KaiStore.


View Demo · Report Bug

Table of Contents

• About the Project
• Building The Project
  • Simulator And Bundling
  • Using KaiOS Devices
• Contributing
• License
• Contact

About The Project

I originally made this game for PC a few years ago for a game jam, you can take a look at it on fergarram.itch.io.

I also wrote a devlog for this project which you can read at dev.to/fergarram.

The game is written in ES6 using Canvas with a WebGL context. I didn't use any wrapper, library or framework for WebGL except for a math utility lib written by webglfundamentals.org.

The simulator was made using Svelte, and the device graphics were traced by hand using a photo of my real Banana Phone using Sketch.

I also created a template for creating similarly-styled KaiOS apps which includes the source code for the simulator.

Building The Project

To get a local copy up and running follow these simple steps.

Simulator And Bundling

For using the simulator and packaging the app you only need NPM:

git clone https://github.com/fergarram/amateur-archaeology.git

npm install

# Local server for the simulator (game included)
npm run dev

# Static files for the simulator (game included)
npm run build:sim

# KaiOS App Package (Develpment)
npm run build

# KaiOS App Package (Production)
npm run build:prod

Using KaiOS Devices

If you want to run this on your real KaiOS device, you need to first enable development mode on it by dialing *#*#33284#*#*. You should be able to see a small bug icon on the status bar of your device.

Then, you need to make sure your device is detected by the adb tool:

> adb devices

List of devices attached
4939400 device

After making sure your device is connected, you need to run the following command to forward your devices debugging TCP port:

adb forward tcp:6000 localfilesystem:/data/local/debugger-socket

Open up Firefox 49.0 (Version is very important!) WebIDE and click on the "Remote Runtime" and then click ok when the popup message appears. Lastly, you select the app-package folder and simply click on the play button.

Setting up the environment for developing on for KaiOS can be tricky at first, you can take a look at this article for more info on that, or read the official documentation at developer.kaiostech.com.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

You can reach out to me through LinkedIn, Dev.to, or Twitter.