New README

FoundationGames · Aug 10, 2022 · d1789e4 · d1789e4
1 parent 91f9698
commit d1789e4
Show file tree

Hide file tree

Showing 9 changed files with 24 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -1,32 +1,34 @@
-# Automobility
-A Minecraft vehicle mod adding customizable cars. <br/><br/>
-
-### Screenshots
-![Standard Cars](./md/standard.png) <br/>
-![Turbo](./md/turbo.png) <br/>
-
-### Try it out!
-Recommended to use along with [MidnightControls](https://www.curseforge.com/minecraft/mc-mods/midnightcontrols), which allows for controller support when driving an automobile. (Already loaded when using in dev environment)
-<br/><br/>
-There are no official releases yet. <br/>
-#### If you would like to try it out:
-**Option A:** Clone the repository and run the game in the dev environment. <br/>
-**Option B:** Download a GitHub Actions artifact from this repository, and use the jar not suffixed with `dev` or `sources`. <br/>
-<br/>
-To get an automobile in game, construct it on an Automobile Assembler using a frame, engine, and four wheels. *Features are not obtainable in survival.* <br/>
-<br/>
-**Driving with Keyboard/Mouse:**
+![Automobility](./md/banner.png)
+
+### A Minecraft mod adding customizable vehicles.
+
+## Available for Fabric/Quilt
+- Requires **[Fabric API](https://modrinth.com/mod/fabric-api)** (Fabric) or **[QSL](https://modrinth.com/mod/qsl)** (Quilt)
+
+**Support for Forge or old versions is NOT PLANNED.**
+
+## Getting Started
+- **Recipes:** Crafting recipes can be viewed using [**EMI**](https://www.curseforge.com/minecraft/mc-mods/emi).
+- **Automobile Parts:** Craft an Auto Mechanic Table. Use the GUI to craft the frame, engine, and wheels for your automobile. You can optionally craft an attachment.
+- **Building your Automobile:** Craft an Automobile Assembler, as well as a Crowbar. Place parts on the assembler until the vehicle is complete. Use a crowbar to destroy the vehicle. After building, add your attachments.
+
+![Automobile Construction](./md/construction.png)
+![Automobile Types](./md/parking.png)
+
+## Driving
 - W - Accelerate
-- S - Brake/Reverse
+- S - Brake/Reverse/Burnout
 - A/D - Steer left/right
 - Space - Drift
 
-**Driving with Controller (MidnightControls):**
+**Controller Support:** when using [MidnightControls](), you will be able to control automobiles with the following default controls:
 - A - Accelerate
 - B - Brake/Reverse
 - LStick - Steer left/right
 - RTrigger - Drift
 
+![Driving](./md/driving.png)
+
 ### Credit: Audio
 All sound effects used (originals licensed under CC0) from [freesound.org](https://freesound.org/): <br/>
 - [ENGINE~1.WAV](https://freesound.org/people/MarlonHJ/sounds/242739/) *by MarlonHJ* <br/>

diff --git a/gradle.properties b/gradle.properties
@@ -15,7 +15,7 @@ myron_version=1.6.3+1.18.1
 arrp_version=0.5.5
 jsonem_version=0.1.2
 
-mod_version = 0.1-pre+1.18.2
+mod_version = 0.1+1.18.2
 maven_group = io.github.foundationgames
 archives_base_name = automobility
 
diff --git a/md/banner.png b/md/banner.png
diff --git a/md/construction.png b/md/construction.png
diff --git a/md/driving.png b/md/driving.png
diff --git a/md/parking.png b/md/parking.png
diff --git a/md/standard.png b/md/standard.png
diff --git a/md/turbo.png b/md/turbo.png
diff --git a/...thub/foundationgames/automobility/util/midnightcontrols/AutomobilityMidnightControls.java b/...thub/foundationgames/automobility/util/midnightcontrols/AutomobilityMidnightControls.java
@@ -20,6 +20,7 @@
 import java.util.function.Supplier;
 
 import static org.lwjgl.glfw.GLFW.*;
+
 public class AutomobilityMidnightControls implements CompatHandler {
     public static final PairPredicate<MinecraftClient, ButtonBinding> ON_AUTOMOBILE = (client, button) -> client.player != null && client.player.getVehicle() instanceof AutomobileEntity;