From e825b08783840795ad6b80f17d0306e78ff6e5a1 Mon Sep 17 00:00:00 2001 From: dvorakmortonxd Date: Tue, 27 Oct 2026 11:43:10 +0000 Subject: [PATCH] updated readme since it was pretty bare-bones before --- README.md | 36 ++++++++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 739de3f..fba9548 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,37 @@ -# My own SpaceSim written in Java -pretty self-explanatory idk what else to write... +
+ +# My own SpaceSim written in Java! + +
+
+ +# Preview: + +
+image + +# This is my work-in-progress game about space, it currently includes: + +- Main menu with cool hovering effects (like the planet hovering and it highlighting when you hover your cursor on it) +- a rocket detaching and landing animation on the ZX311 planet +- an observatory and a walkable land on the ZX311 +- neat and buttery smooth movement +- thats about it. I plan to add more stuff to the planet and a way to travel to more planets but I'm gonna need more time for that :) + +# Why did I make this? +Well I've always liked space games (especially galacticraft and ad astra modpacks in minecraft) and I thought it would keep me going on making a game about it, I also thought it would pretty much fit into this weeks theme ("Outside") on Terra, so I just went for it! also I wanted to learn to make games in java since one of my favourite games (minecraft) is written in Java and I wanted to learn java for a long time, also it would help me in school since right now we are doing C# in school which has a really similar syntax to java :) + +# How do I play? what are the controls for the game? +Well it is pretty basic, the main menu is just click and go so basically you only use your mouse cursor there, and until the rocket lands there aren't any other controls except the debug ones (I'll mention them at the end of this section), and when you land, theres only the basic WASD movement (however the W/S keys are used mainly for doors and stuff, since you cant really walk forward/backward on a 2d window lol) and space to jump (this one is self-explanatory). Now to the debug keys, if you opened this game in a terminal, then you can use the Control key (Ctrl) to get the players X and Y position (though it says the upper left corner of the players sprite since that's where it renders), and also this one you can use whenever but the Slash key (/) will skip the rocket's animation and will skip you to all the way to the part where you land so you can move immidiently (this will work anywhere so it's not really just the skip, it's basically a teleport to landing site and activates player movement). + +## how was this made? +I made it using Java 21 and the Swing library and Java's 2D Graphics :) + +# Thank you for playing/reviewing this project! below theres a few credits I thought made sense ## docs I'd like to keep close Swing tutorial (Oracle): https://docs.oracle.com/javase/tutorial/uiswing/ JFrame, JPanel, key listeners, timers, etc.