Skip to content

Commit

Permalink
Update README, add brief tutorial.
Browse files Browse the repository at this point in the history
  • Loading branch information
Demindiro committed Jul 12, 2021
1 parent 4f570e3 commit d456f8f
Show file tree
Hide file tree
Showing 3 changed files with 69 additions and 3 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,23 @@ The game is *libre* software: the AGPLv3 license permits you to do whatever
you want with the source code provided you grant the same permissions to other
people.

It is recommended to read `TUTORIAL.md` to get started.


## Features

* You can create any vehicle using basic blocks. There are quite a few blocks to
give your creations detail as well as functional blocks such as wheels, weapons,
...

* The damage system is voxel-based: vehicles are torn down block-by-block.

* The game supports multiplayer. You can join any server and host your own too.

* Since the game is entirely free (as in [freedom][gnu free sw]) you can modify
it to any extent. In fact, I highly encourage people to tinker with it and
experiment with what works & doesn't work.


## Building the game.

Expand All @@ -31,3 +48,22 @@ been tested for Linux so far.
in the `README` of `godot_rapier3d` to build the engine.

2) Use the `Makefile` in this repository to build the game.


## Downloads

You can find stable releases [here](https://github.com/Demindiro/OwnWar/releases)


## Gallery

![Start menu](https://static.salt-inc.org/own_war/ownwar_start_menu.jpg)

![Editor](https://static.salt-inc.org/own_war/ownwar_editor.jpg)

![Test map](https://static.salt-inc.org/own_war/ownwar_test_map.jpg)

![The Pit](https://static.salt-inc.org/own_war/ownwar_the_pit.jpg)


[gnu free sw]: https://www.gnu.org/philosophy/free-sw.en.html
30 changes: 30 additions & 0 deletions TUTORIAL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Beginner's tutorial

This is a brief tutorial for players who are new to this game. It is still
very much a work-in-progress and will at some point be replaced with an
in-game guide.


## Creating a basic vehicle.

A valid vehicle has a few basic requirements:

* There must be **exactly** one mainframe. You can find the mainframe block in
the `Other` tab in the inventory (you can open it with) E.

* All blocks must be connected. All bodies that do not have a mainframe must
have **exactly** one connection to a parent body.


### Creating turrets.

1) Place a turret block on a body (e.g. the main body).

2) Create a new layer, which is done with the `+` in the bottom-left window.

3) Make sure you switched to the new layer. The previous body should now be
transparent.

4) Place blocks on top of the turret block.

5) Repeat this process for sub-turrets.
6 changes: 3 additions & 3 deletions gd/blocks/weapons/plasma/cannon.tres
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ surfaces/1 = {

[resource]
script = ExtResource( 1 )
revision = 1
human_category = "Weapons"
mass = 1.0
human_name = "Plasma Cannon"
mass = 1.0
human_category = "Weapons"
revision = 1
aabb = AABB( 0, 0, 0, 1, 1, 3 )
id = 90
health = 100
Expand Down

0 comments on commit d456f8f

Please sign in to comment.