Skip to content

Commit ab632a2

Browse files
committed
better docs
1 parent 794f79e commit ab632a2

File tree

224 files changed

+74359
-29554
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

224 files changed

+74359
-29554
lines changed

.idea/libraries/KotlinJavaRuntime.xml

Lines changed: 19 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/misc.xml

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/vcs.xml

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

JavaGameEngine.iml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,12 @@
66
<sourceFolder url="file://$MODULE_DIR$/res" type="java-resource" />
77
<sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
88
<sourceFolder url="file://$MODULE_DIR$/docs/docs/src/JavaExampels" isTestSource="false" />
9+
<sourceFolder url="file://$MODULE_DIR$/docs/Docs/openapi/code_samples/Java" isTestSource="false" />
910
<excludeFolder url="file://$MODULE_DIR$/src/Testing/Physics" />
1011
<excludeFolder url="file://$MODULE_DIR$/src/Testing/Overhead" />
1112
</content>
1213
<orderEntry type="inheritedJdk" />
1314
<orderEntry type="sourceFolder" forTests="false" />
15+
<orderEntry type="library" name="KotlinJavaRuntime" level="project" />
1416
</component>
1517
</module>

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<div align="center">
2222

2323

24-
<h3 align="center">JavaGameEngine</h3>
24+
<h3 align="center">javagameengine</h3>
2525

2626
<p align="center">
2727
An awesome Game Engine to jumpstart your game projects!
@@ -71,9 +71,9 @@
7171

7272
## Examples
7373
<h3><a href="https://github.com/Java-Game-Maker/Demo1">Link to demo1</a></h3>
74-
<img src="https://github.com/Java-Game-Maker/JavaGameEngine/blob/main/images/demo1.gif" name="image-name">
74+
<img src="https://github.com/Java-Game-Maker/javagameengine/blob/main/images/demo1.gif" name="image-name">
7575
<h3><a href="https://github.com/Java-Game-Maker/Demo2">Link to demo2</a></h3>
76-
<img src="https://github.com/Java-Game-Maker/JavaGameEngine/blob/main/images/demo2.gif" name="image-name">
76+
<img src="https://github.com/Java-Game-Maker/javagameengine/blob/main/images/demo2.gif" name="image-name">
7777

7878
<!-- ABOUT THE PROJECT -->
7979
## About The Project
@@ -93,7 +93,7 @@ Here's why:
9393

9494
### Built With
9595

96-
The JavaGameEngine is build with vanila java 1.8 with the swing framework as the input and drawing aspects
96+
The javagameengine is build with vanila java 1.8 with the swing framework as the input and drawing aspects
9797

9898
* [Java](https://www.oracle.com/java/technologies/downloads/)
9999

@@ -118,11 +118,11 @@ Be sure yoy have the jre installed
118118
### Installation
119119

120120
You can clone this repo and play around with the Testing package where we test the engine and then build the artifact and import the jar to your own project.
121-
Or you can download the jar file in the <a href="https://github.com/Java-Game-Maker/JavaGameEngine/blob/main/out/artifacts/JavaGameEngine_jar/JavaGameEngine.jar" >output folder<a> and import the jar to your project.
121+
Or you can download the jar file in the <a href="https://github.com/Java-Game-Maker/javagameengine/blob/main/out/artifacts/JavaGameEngine_jar/javagameengine.jar" >output folder<a> and import the jar to your project.
122122

123123
1. Clone the repo
124124
```sh
125-
git clone https://github.com/Java-Game-Maker/JavaGameEngine.git
125+
git clone https://github.com/Java-Game-Maker/javagameengine.git
126126
```
127127

128128

@@ -135,7 +135,7 @@ Be sure yoy have the jre installed
135135

136136
_For more examples, please refer to the [Documentation](https://example.com)_
137137

138-
To get started create a main.java file where you extend the JavaGameEngine class
138+
To get started create a main.java file where you extend the javagameengine class
139139
In your public static void main(String[] args){} method
140140

141141
```
@@ -167,17 +167,17 @@ A example on how to use it
167167
```
168168
package example;
169169
170-
import JavaGameEngine.Backend.ComponentHandler;
171-
import JavaGameEngine.Backend.UpdateThread;
172-
import JavaGameEngine.Components.GameObject;
173-
import JavaGameEngine.JavaGameEngine;
174-
import JavaGameEngine.msc.Vector2;
170+
import javagameengine.backend.ComponentHandler;
171+
import javagameengine.backend.UpdateThread;
172+
import javagameengine.components.GameObject;
173+
import javagameengine.javagameengine;
174+
import javagameengine.msc.Vector2;
175175
176176
import javax.swing.*;
177177
import java.awt.*;
178178
179179
180-
public class Main extends JavaGameEngine{
180+
public class Main extends javagameengine{
181181
182182
public static Ob parent;
183183
public static Ob child;
@@ -290,7 +290,7 @@ Distributed under the MIT License. See `LICENSE.txt` for more information.
290290

291291
Alfred Roos - alfred@stensatter.se
292292

293-
Project Link: [https://github.com/Java-Game-Maker/JavaGameEngine](https://github.com/Java-Game-Maker/JavaGameEngine)
293+
Project Link: [https://github.com/Java-Game-Maker/javagameengine](https://github.com/Java-Game-Maker/JavaGameEngine)
294294

295295
<p align="right">(<a href="#top">back to top</a>)</p>
296296

Shape project/src/com/company/Main.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
package com.company;
22

3-
import JavaGameEngine.Backend.ComponentHandler;
4-
import JavaGameEngine.Backend.Input.Input;
5-
import JavaGameEngine.Backend.Input.Keys;
6-
import JavaGameEngine.Components.GameObject;
7-
import JavaGameEngine.JavaGameEngine;
8-
import JavaGameEngine.msc.Debug;
9-
import JavaGameEngine.msc.Vector2;
3+
import javagameengine.backend.ComponentHandler;
4+
import javagameengine.backend.input.Input;
5+
import javagameengine.backend.input.Keys;
6+
import javagameengine.components.GameObject;
7+
import javagameengine.JavaGameEngine;
8+
import javagameengine.msc.Debug;
9+
import javagameengine.msc.Vector2;
1010

1111
import javax.swing.plaf.basic.BasicTreeUI;
1212
import java.awt.*;

0 commit comments

Comments
 (0)