|
1 | | - |
2 | | -<p align="center"> |
3 | | -<img src="https://meteorclient.com/icon.png" alt="meteor-client-logo" width="15%"/> |
4 | | -</p> |
5 | | - |
6 | | -<h1 align="center">Meteor</h1> |
7 | | -<p align="center">A Minecraft Fabric Utility Mod for anarchy servers.</p> |
8 | | - |
9 | | -<div align="center"> |
10 | | - <a href="https://discord.gg/bBGQZvd"><img src="https://img.shields.io/discord/689197705683140636?logo=discord" alt="Discord"/></a> |
11 | | - <br> |
12 | | - <img src="https://img.shields.io/github/last-commit/MeteorDevelopment/meteor-client" alt="GitHub last commit"/> |
13 | | - <img src="https://img.shields.io/github/commit-activity/w/MeteorDevelopment/meteor-client" alt="GitHub commit activity"/> |
14 | | - <img src="https://img.shields.io/github/contributors/MeteorDevelopment/meteor-client" alt="GitHub contributors"/> |
15 | | - <br> |
16 | | - <img src="https://img.shields.io/github/languages/code-size/MeteorDevelopment/meteor-client" alt="GitHub code size in bytes"/> |
17 | | - <img src="https://img.shields.io/endpoint?url=https://ghloc.vercel.app/api/MeteorDevelopment/meteor-client/badge?filter=.java$&label=lines%20of%20code&color=blue" alt="GitHub lines of code"/> |
18 | | -</div> |
19 | | - |
20 | | -## Usage |
21 | | - |
22 | | -### Building |
23 | | -- Clone this repository |
24 | | -- Run `./gradlew build` |
25 | | - |
26 | | -### Installation |
27 | | -Follow the [guide](https://meteorclient.com/faq/installation) on the wiki. |
28 | | - |
29 | | -## Contributions |
30 | | -We will review and help with all reasonable pull requests as long as the guidelines below are met. |
31 | | - |
32 | | -- The license header must be applied to all java source code files. |
33 | | -- IDE or system-related files should be added to the `.gitignore`, never committed in pull requests. |
34 | | -- In general, check existing code to make sure your code matches relatively close to the code already in the project. |
35 | | -- Favour readability over compactness. |
36 | | -- If you need help, check out the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html) for a reference. |
37 | | - |
38 | | -## Bugs and Suggestions |
39 | | -Bug reports and suggestions should be made in this repo's [issue tracker](https://github.com/MeteorDevelopment/meteor-client/issues) using the templates provided. |
40 | | -Please provide as much information as you can to best help us understand your issue and give a better chance of it being resolved. |
41 | | - |
42 | | -## Donations |
43 | | -All of our work is completely free and non-profit (donations pay only for hosting costs), therefore we are very grateful for all donations made to support us in running our community. |
44 | | -Donations can be made via our [website](https://meteorclient.com/donate) and the minimum amount to get donor benefits is €5. |
45 | | -You will be rewarded with a role on our Discord server and a customisable in-game cape. |
46 | | -⚠️ _Make sure to create a Meteor account and link your Discord and Minecraft accounts to fully experience your rewards._ ⚠️ |
47 | | - |
48 | | -## Credits |
49 | | -[Cabaletta](https://github.com/cabaletta) and [WagYourTail](https://github.com/wagyourtail) for [Baritone](https://github.com/cabaletta/baritone) |
50 | | -The [Fabric Team](https://github.com/FabricMC) for [Fabric](https://github.com/FabricMC/fabric-loader) and [Yarn](https://github.com/FabricMC/yarn) |
51 | | - |
52 | | -## Licensing |
53 | | -This project is licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html). |
54 | | - |
55 | | -If you use **ANY** code from the source: |
56 | | -- You must disclose the source code of your modified work and the source code you took from this project. This means you are not allowed to use code from this project (even partially) in a closed-source and/or obfuscated application. |
57 | | -- You must state clearly and obviously to all end users that you are using code from this project. |
58 | | -- Your application must also be licensed under the same license. |
59 | | - |
60 | | -*If you have any other questions, check our [FAQ](https://meteorclient.com/faq) or ask in our [Discord](https://meteorclient.com/discord) server.* |
0 commit comments