From fc5e24077b4b830ab98e9d8127e08ed8ca8eb610 Mon Sep 17 00:00:00 2001 From: Ciro Diaz <161502824+CiroZDP@users.noreply.github.com> Date: Sat, 14 Sep 2024 00:21:04 +0200 Subject: [PATCH] Update README.md --- README.md | 167 +++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 139 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 3980cd8..01cffd9 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,153 @@
- -

OpenCraft

-
- Download OpenCraft + +[![Contributors][contributors-shield]][contributors-url] +[![Forks][forks-shield]][forks-url] +[![Stargazers][stars-shield]][stars-url] +[![Issues][issues-shield]][issues-url] +[![MPL License][license-shield]][license-url] + +
+ +

+
+ + + + +

OpenCraft

+ +

+ A roughly calculated clone of Minecraft +

+ + Explore the docs ยป + +
+ + Report Bugs + + ยท + + Download + + ยท + + Feature Request + +

-[![Download OpenCraft](https://a.fsdn.com/con/app/sf-download-button)](https://sourceforge.net/projects/OpenCraftMC/files/latest/download) +
+ +> [!WARNING] +> This project **IS NOT** affiliated with Mojang or other minecraft product.
+> This is just a hobby and I do not take care of any uses provided to this utility. + +> ```FOR SUPPORT:``` https://github.com/OpenCraft-Studios/Java-Edition/issues/
+> ```FOR CONTRIBUTING:``` https://github.com/OpenCraft-Studios/Java-Edition/pulls + +
+ +# โœ… Getting started +**OpenCraft** is a game programmed in Java, it has the same motor (LWJGL 2 + Java 17) that Minecraft. + +### Why this project? ๐Ÿค” +> I created this project because Minecraft is closed-source. I know that you can decompile it, but modification +> and redistribution of a modified copy of Minecraft is actually illegal. So I created a clone of Minecraft that +> allows modification and redistribution. + +I want to create a community around this project, +I hope that you can be part of that community forking the repository or simply, bring us a star :heart: + +
+ +

Screenshots

+
+

+ GIF  + PNG +

+
+ PNG +

+6 languages

+
+
+ +--- + +# โ˜• Downloading +For now, we don't have prebuild jars. You need to compile it manually. +Although you will need a launcher to play the game because it needs of libraries. + +> [!NOTE] +> Every required libraries are open-source and free, so you can download them easily. + +If you don't want to use a launcher, you can execute it manually. Only **follow these steps**: + +1. Make sure you have Java **1.8** or above installed:
+ `java --version` *= 1.8* + +2. Make sure you have the latest version of OpenCraft downloaded. + +3. Make sure you have the libraries to execute OpenCraft. + +If you are already to execute OpenCraft. Follow these instructions. + +**Windows** +```batch +java -cp OpenCraft.jar;libraries.jar; net.opencraft.OpenCraft --gameDir opcraft +``` + +**Bash** +```bash +#!/bin/bash +java -cp OpenCraft.jar:libraries.jar: net.opencraft.OpenCraft --gameDir opcraft/ +``` + +--- + +# โš–๏ธ License + +**You can:** +- Make modifications of this project. *(includes modifying texture, resources, classes,...)* +- Redistribute that modifications. *(without impersonating anyone)* +- Give yourself part of the credits. *(but giving most of the credits to the original authors)* +- Obfuscate **some parts** of the code to promote security. *(authentication purposes,...)* -## About โ„น๏ธ -**OpenCraft** is programmed on Java. -Any library used here is open-source. This project is open-source and free for everyone. If you want, you can donate or fork this repository. +--- -- Related: **Contributing โค๏ธ** +**You must not:** +- Sell the game or its modifications. +- Change the license document. +- Put malware in the code of this repository or any forks of it. +- Impersonate authors of the project. -## How to build it? -For build this project you need to have Apache NetBeans or Eclipse IDE or JetBrains IntelliJ IDEA. -Open the project in the IDE, and build it. +--- -Lastly, execute it and you can make all mods you want. +**You must:** +- Give credits to the original authors of this project. -## Developers ๐Ÿ‘ทโ€โ™‚๏ธ -- [Ciro Diaz](https://github.com/CiroZDP/) (Principal developer) +--- -## Getting Help ๐Ÿ™‹ -Go to the [official discord server](https://discord.gg/wrjEBqNRq9) for support. +**The full license is at [BSL 1.0][license-url].** -## Translating ๐ŸŒ -Actually, OpenCraft supports +7 languages: If you want to improve the translations, please, -checkout the [Langsheet](https://github.com/OpenCraftStudios/piston-data/blob/main/langsheet.csv). +
-| **NOTE** | This langsheet is automatically downloaded by OpenCraft. So the changes will apply inmediatly. | -|----------|------------------------------------------------------------------------------------------------| -## Contributing โค๏ธ -We are a small community so we need help to implement upgrades for new OpenCraft versions, fixing bugs and expanding the project. -We are always looking for motivated people to contribute. If you feel like it could be you, -please have a look at the [issues section](https://github.com/OpenCraftStudios/Java-Edition/issues) :) +# ๐Ÿ‘ทโ€โ™‚๏ธ Developers +| [![CiroZDP](https://avatars.githubusercontent.com/u/161502824?v=4)](https://github.com/CiroZDP) | ![Community](https://cdni.iconscout.com/illustration/free/thumb/free-community-2103591-1768087.png) | +| :---------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------: | +| **CiroZDP** | **The community** | -![Alt](https://repobeats.axiom.co/api/embed/5e91596ce692d176bc879f99eecd6e0fd009675a.svg "Repobeats analytics image") +--- -- Related: [**How i make a fork?**](https://docs.github.com/articles/fork-a-repo) +[contributors-shield]: https://img.shields.io/github/contributors/OpenCraft-Studios/Java-Edition.svg?style=for-the-badge +[contributors-url]: https://github.com/OpenCraft-Studios/Java-Edition/graphs/contributors +[forks-shield]: https://img.shields.io/github/forks/OpenCraft-Studios/Java-Edition.svg?style=for-the-badge +[forks-url]: https://github.com/OpenCraft-Studios/Java-Edition/network/members +[stars-shield]: https://img.shields.io/github/stars/OpenCraft-Studios/Java-Edition.svg?style=for-the-badge +[stars-url]: https://github.com/OpenCraft-Studios/Java-Edition/stargazers +[issues-shield]: https://img.shields.io/github/issues/OpenCraft-Studios/Java-Edition.svg?style=for-the-badge +[issues-url]: https://github.com/OpenCraft-Studios/Java-Edition/issues +[license-shield]: https://img.shields.io/github/license/OpenCraft-Studios/Java-Edition.svg?style=for-the-badge +[license-url]: https://github.com/OpenCraft-Studios/Java-Edition/blob/main/LICENSE.txt