lucvandenbrand / ggj18

Snappy Cobra - Global Game Jame Game 2018.

GGJ18

A game developed for the Global Game Jam 2018!

🔩 Build and Run

This is a Unity project, so simply open the project from Unity and build it. The project is setup under Unity 2017.3.0 Windows, other versions might work, but are not officially supported!. Linux users might try this build.

💼 Branch Workflow

Development

The development branch (or branches related to it) contains all active work.

Master

The master branch contains all work that is production-ready. Before anything can be merged into master, it must be approved by a pull-request!

🎮 Unity Workflow

Within the Scenes folder, there is space for an ignored KlootScenes folder. This folder is for you to mess around with on your own, the folder is never commited such that you do not need to worry about merge conflicts.

Keep in mind: merge conflicts are truly avoided by proper communication!

Installing and running Elixir for the server code:

The server code is contained in te snappy_server folder.

To install Elixir, I recommend using the asdf version manager.

https://github.com/asdf-vm/asdf

You'll need Erlang, Elixir and nodejs.

asdf plugin-add erlang
asdf plugin-add elixir
asdf plugin-add nodejs

# If problems during installing Erlang, install these packages first: https://github.com/asdf-vm/asdf-erlang#before-asdf-install
asdf install erlang 20.1
asdf global erlang 20.1

asdf install elixir 1.5.2
asdf global elixir 1.5.2

asdf install nodejs 9.4.0
asdf global nodejs 9.4.0

Then, go to the snappy_server folder and run mix deps.get to install the Elixir dependencies.

Then, go to the snappy_server/assets folder, and install the nodejs dependencies using npm install.

Then, you can start the server from snapp_server by typing mix phx.server.

While running this in your terminal, start the game in Unity. It will attempt to connect at (for now) port 8002.

The web-view for on phones can (for now) be seen at port 4000.

ggj18's Issues

Elixir Web server

Rust Game Logic

Needs to interface with Elixir.

Refactor Unity Code

It is always a nice practice to refactor the code after a Jam. The process gives proper insight in the core design of the game, and also make you hate Unity less ;)

Things one could do:

• Rename variables, classes and gameobjects to have a proper semantic meaning.
• Move constants out of the code and into parameters.
• Remove code duplication (and improve reusability)
• Ensure constant formatting.
• Improve readability of the code.

A general advice is to make the code adapt to this cheat-sheet: https://www.planetgeek.ch/wp-content/uploads/2014/11/Clean-Code-V2.4.pdf

Architecture decisions

Game build for Web. Split into multiple components.

• Rust Game Logic linked with Elixir server.
• Web based Controller communicating with server.
• Web based display code (Flow? Typescript? ThreeJS?).

Controller Web based

Web based display code

Does the exact unity version matter?

I have unity version 2017.3.0p2 (linux) but when I opened the project I got a warning that the project was last built on version 2017.3.0f1

Does this matter?

Can't build

I can't build because of the use of UnityEditor in the scripts (and removing that gives other errors).

Could someone who has succesfully built the game push the fix?