From e142fcfc81c8593dd6f8e5cf0151f95c41eb202b Mon Sep 17 00:00:00 2001 From: Miguel Pelaez Date: Tue, 13 Feb 2018 15:20:17 -0500 Subject: [PATCH] Add docs --- .gitignore | 1 - docs/CODE_OF_CONDUCT.md | 73 +++++++++++++++++++++++++++++++++++++++++ docs/CONTRIBUTING.md | 43 ++++++++++++++++++++++++ docs/README.md | 54 ++++++++++++++++++++++++++++++ 4 files changed, 170 insertions(+), 1 deletion(-) create mode 100644 docs/CODE_OF_CONDUCT.md create mode 100644 docs/CONTRIBUTING.md create mode 100644 docs/README.md diff --git a/.gitignore b/.gitignore index cd9e807..3e2437e 100644 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,6 @@ .vscode/ docs.json __dummy.html -docs/ /litecraft /litecraft.so /litecraft.dylib diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..c2238d5 --- /dev/null +++ b/docs/CODE_OF_CONDUCT.md @@ -0,0 +1,73 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at kernelfreeze [at] greenlab [dot] games. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..4dc2dd6 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,43 @@ +# Contributing + +We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: + +- Reporting a bug +- Discussing the current state of the code +- Submitting a fix +- Proposing new features +- Becoming a maintainer + +## We Develop with Github +We use github to host code, to track issues and feature requests, as well as accept pull requests. + +## Any contributions you make will be under the MIT Software License +In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern. + +## Report bugs using Github's [issues](https://github.com/Litecrafty/Litecraft/issues) +We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy! + +**Great Bug Reports** tend to have: + +- A quick summary and/or background +- Steps to reproduce + - Be specific! + - Give sample code if you can. +- What you expected would happen +- What actually happens +- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) + +## Contributing source code + +When contributing to this repository, please first discuss the change you wish to make via issue, +email, or any other method with the owners of this repository before making a change. + +Please note we have a code of conduct, please follow it in all your interactions with the project. + +## Pull Request Process + +1. Ensure any install or build dependencies are removed before the end of the layer when doing a + build. +2. Update the README.md with details of your features, this includes new command line parameters, FAQs, and useful file locations. +3. You may merge the Pull Request in once you have the sign-off of two other developers, or if you + do not have permission to do that, you may request the second reviewer to merge it for you. \ No newline at end of file diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..40b6c38 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,54 @@ +# Litecraft +[![Discord](https://img.shields.io/discord/371055566480605184.svg)](https://discord.gg/qKjuDxx) + + + +[Open source](https://en.wikipedia.org/wiki/Free_and_open-source_software), [clean room](https://en.wikipedia.org/wiki/Clean_room_design) implementation of [Minecraft](https://minecraft.net) Client. Although this implementation does not use any Mojang source code, you must have a valid Minecraft account to play. We do not support piracy in any way. + +# Features +- [X] Native perfomance and better memory management. (Thanks to D Programming Language). +- [X] Better rendering system. +- [X] Multi-thread and low Heap allocations. +- [X] Rendering using shaders. [Shaders are faster than old OpenGL](https://thebookofshaders.com/00/). +- [X] Safe by design. +- [X] Supported by an awesome community. +- [X] Modern design (Design patterns and use of VAOs, VBOs, EBOs, etc), use of new interfaces and libraries (like OpenGL >= 3.0). +- [ ] All vanilla client features. +- [ ] Launcher with assets downloader [(WIP!)](https://github.com/Litecrafty/Launcher) +- [ ] Server side plugin (mod) API (Send resources from server to client) +- [ ] More soon™ We have some crazy ideas... ;) + +# Screenshots + + + + +# Clone and Compile + + - Install and enable Git LFS for assets and libraries download. + - Clone the repository. + - Download D Programming Language: `dub`, `ldc2` or any D compiler, and `gcc` as linker. + - Install libraries: `glfw3`. + - Build with dub. + - Run with our [Launcher](https://github.com/Litecrafty/Launcher) or manually with any client token: +```bash +dub build && ./litecraft TESTTOKEN +``` + - Profit! + +# F.A.Q + +### I want to help! Where can I learn D? +Here: https://tour.dlang.org + +### How long will it take you to program a usable version? +Although we have thousands of hours of work, we probably have many thousands more. + +### Litecraft is supposed to be faster, why does not it support old computers with OpenGL 2.1? +OpenGL 3.X has been launched for more than 10 years, besides facilitating the development, it allows us to do things in a more efficient way that otherwise would not be possible. If you really want to use OpenGL 2.1 or 1.1, we recommend using Minecraft Vanilla, sorry :( + +# Contributing +[Bug reports](https://github.com/Litecrafty/Litecraft/issues) and [pull requests](https://github.com/Litecrafty/Litecraft/pulls) are welcome on our GitHub. This project is intended to be a safe, welcoming space for collaboration and discussion, and contributors are expected to adhere to the [Contributor Covenant code of conduct](https://github.com/Litecrafty/Litecraft/blob/master/CONTRIBUTING.md), you can read it on your Language [here](https://www.contributor-covenant.org/translations.html). + +# License +[Apache License 2.0](https://github.com/Litecrafty/Litecraft/blob/master/LICENSE) \ No newline at end of file