Created README.md

This commit is contained in:
OLEGSHA 2020-07-29 12:56:19 +03:00 committed by GitHub
parent e96a30c275
commit 021c63cf98
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

49
README.md Normal file
View File

@ -0,0 +1,49 @@
# Optica
A free, open source sandbox survival game currently in early development.
## Contributing
For now, contact @Javapony in Telegram for details. Contributing is completely allowed, but we don't have any set guidelines yet.
## Building
1. `$ git clone https://github.com/OLEGSHA/Optica.git`
2. `$ gradlew build`
### Additional setup for Eclipse IDE
If you have Buildship plugin installed, use File - Import - Gradle - Existing Gradle Project. Main class is `ru.windcorp.optica.client.OpticaClientMain`.
Alternatively do the following:
1. Add `id 'eclipse'` into `build.gradle` inside `plugins { ... }`:
```
plugins {
// Apply the java-library plugin to add support for Java Library
id 'java-library'
id 'eclipse'
}
```
2. `$ gradlew eclipse`
3. Import the project with File - Import - Existing Projects into Workspace
### Additional setup for IntelliJ IDEA
1. Add `id 'idea'` into `build.gradle` inside `plugins { ... }`:
```
plugins {
// Apply the java-library plugin to add support for Java Library
id 'java-library'
id 'idea'
}
```
2. `$ gradlew idea`
3. Open the project with File - Open Project
## Libraries
* LWJGL - OpenGL, OpenAL, GLFW and several more libraries ported to Java
* Google Guava
* Trove4j
* java-graphics/glm - GLM ported to Java. _Maven Central contains an outdated version, a custom repository used instead_
* Apache Commons Math (_not currently used_)