Skip to content
This repository has been archived by the owner on Oct 24, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
CiroZDP authored Sep 13, 2024
1 parent 1dc6aff commit fc5e240
Showing 1 changed file with 139 additions and 28 deletions.
167 changes: 139 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,153 @@
<div align="center">
<img src="https://github.com/OpenCraftStudios/Java-Edition/blob/dev/.github/assets/images/icon.png?raw=true" alt="" height="128" width="128" />
<h1>OpenCraft</h1>
<br>
<a href="https://sourceforge.net/projects/OpenCraftMC/files/latest/download"><img alt="Download OpenCraft" src="https://img.shields.io/sourceforge/dt/OpenCraftMC.svg" ></a>

[![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]

</div>

<br /><br />
<div align="center">
<a href="https://github.com/OpenCraft-Studios/Java-Edition">
<img src="https://github.com/OpenCraft-Studios/Java-Edition/blob/dev/.github/assets/images/icon.png?raw=true" alt="" height="128" width="128" />
</a>

<h3 align="center">OpenCraft</h3>

<p align="center">
A roughly calculated clone of Minecraft
<br /><br />
<a href="https://github.com/OpenCraft-Studios/Java-Edition/wiki">
<b>Explore the docs »</b>
</a>
<br />
<a href="https://github.com/OpenCraft-Studios/Java-Edition/issues">
Report Bugs
</a>
·
<a href="#-downloading">
Download
</a>
·
<a href="https://github.com/OpenCraft-Studios/Java-Edition/pulls">
Feature Request
</a>
</p>
</div>

[![Download OpenCraft](https://a.fsdn.com/con/app/sf-download-button)](https://sourceforge.net/projects/OpenCraftMC/files/latest/download)
<br />

> [!WARNING]
> This project **IS NOT** affiliated with Mojang or other minecraft product. <br />
> 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/ <br />
> ```FOR CONTRIBUTING:``` https://github.com/OpenCraft-Studios/Java-Edition/pulls
<br />

# ✅ 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:

<details open>
<summary>
<h3>Screenshots</h3>
</summary><br />
<p align="center">
<img width="49%" src="images/screenshot1.gif" alt="GIF"/>&nbsp;
<img width="49%" src="images/screenshot2.png" alt="PNG"/>
</p>
<div align="center">
<img width="80%" src="images/screenshot3.png" alt="PNG"/>
<p><b>+6 languages</b></p>
</div>
</details>

---

# ☕ 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: <br />
`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).
<br />

| **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

0 comments on commit fc5e240

Please sign in to comment.