# mutable-bunnies-client

**Repository Path**: github-codes/mutable-bunnies-client

## Basic Information

- **Project Name**: mutable-bunnies-client
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-02-11
- **Last Updated**: 2022-02-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Mutable Bunnies - Game Client

Browser based game client for the Mutable Bunnies game server. [Mutable Bunnies - Server](https://github.com/codingchili/mutable-bunnies-server)

<p align="center" style="text-align: center">
  <img height="600" src="img/character-create v2.png">
</span>

New version of the character creator, now with animated previews using spine/webM.

Check out the first demo [demo video](https://www.youtube.com/watch?v=TlFcvCJb9lw)

Uses Pixi.js for rendering and assets from gamedeveloperstudio, see [license](https://www.gamedeveloperstudio.com/license.php). This repository doesn't contain any client code or assets - as these may not be included in any open source listing. Contributions are welcome for the backend but only the core team may work on the client scripts/assets.

# Install & run

Until mutable-bunnies-server has a release available this repository should be cloned as a submodule to the 
mutable-bunnies-server project. See the instructions in the [repo](https://github.com/codingchili/mutable-bunnies-server)
on how to clone.

**Note**: The client requires licensed resources which are available as a submodule under 
`website/resources`. If you don't have acess to this repository then you need to set the
realm resource url to the public resource CDN. (which doesn't exist yet.)

When cloned as a git submodule inside the server project, the server can be started with

```console
./gradlew :client:generate
./gradlew :client:run
```

Create the distribution zip and run polymer build with:
```console
./gradlew :client:distribution
```

Building a docker image, make sure to build the distribution zip first.

```console
cd client
docker build -f Dockerfile ./build
docker run -p 8080:8080 -p 1448:1448 -p 9301:9301 -it <imageId>

docker tag <imageId> codingchili/mutable-bunnies
docker run -it -p 9302:9302 -p 8080:8080 -p 1448:1448 -p 9301:9301 codingchili/mutable-bunnies
```

# Configuration

The webserver can be configured in conf/service/web.yaml.

Example of the default configuration,

```yaml
---
node: "website.node"
startPage: "index.html"
missingPage: "404.html"
resources: "website/"
cache: false
gzip: false
global: "LSc7+5GuvEPkt80gTa9X6IdteHJ++aZWkBYsbWnvB1NpOEP6RcfW03qXNFj9HO4YAUX6JxohipZm51rReU553Q=="
logging:
  properties:
    type: "HmacSHA512"
  domain: "website.node"
  key: "+DPBfH6OGlvBvoLCKqlWZcj67apYCDBrQf1fZcllxW2xpwOB0VGqWHMCYnABgmZsS1NWNvk+6VOpQPfFbf5LKA=="
  expiry: 1599990680
listener:
  secure: true
  port: 443
```

See [conf/system/certificates/README.md](conf/system/certificates/README.md) for information on how to set up keystores
with `secure: true`. If keystore is unset then a test certificate is generated on the fly.

### Configuration paths

- conf/system - configuration for the [chili-core](https://github.com/codingchili/chili-core) framework.
- conf/game - game configuration, such as instances, items and npcs.
- conf/realm - realm server configuration.
- conf/service - microservices configuration, realm deployer, realm registry, authentication, banking etc.


### Progress

Overview of the client implementation progress

User interface
- [X] spellbar
- [X] character status
- [X] chat box
- [X] creature targeting
- [X] inventory
- [X] quest tracker
- [X] spell book 
- [X] player skills
- [X] friends/chat
- [ ] crafting
- [ ] in-game help

Effects
- [X] skybox
- [X] sound effects
- [X] spell effects

Website
- [X] patch notes
- [X] realm list
- [X] character creation
- [X] login
- [ ] highscores
- [ ] character viewer
- [x] auction client

##### Great software :blue_heart:
To make this project a reality we use only great software.

On the backend
- [mutable bunnies](https://github.com/codingchili/mutable-bunnies-server)  mutable bunnies server.

On the frontend
- [lit-html](https://lit-html.polymer-project.org/) for the website and game UI.
- [PIXI.js](http://www.pixijs.com/) for client side rendering.

For art
- [Spine 2d](http://esotericsoftware.com/) for animations!
- [Affinity Designer](https://affinity.serif.com/en-us/designer/) for creating vector art!
- [MagicaVoxel](https://ephtracy.github.io/) for isometric artwork!
- [Game Icons](https://game-icons.net/) for all of the vector icons!
- [Game Developer Studio](https://www.gamedeveloperstudio.com/) for buying awesome vector art!
- [Ableton Live](https://www.ableton.com/) for the background music!