Skip to content

Commit

Permalink
Add first version of README and COC
Browse files Browse the repository at this point in the history
  • Loading branch information
ThexXTURBOXx committed Feb 9, 2025
1 parent 80d4f94 commit 1489e27
Show file tree
Hide file tree
Showing 2 changed files with 213 additions and 0 deletions.
134 changes: 134 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@

# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders 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, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
`nico.mexis 'at' kabelmail 'dot' de`.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations

79 changes: 79 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Expanded Armory: Legacy

[![Workflow status](https://img.shields.io/github/actions/workflow/status/ThexXTURBOXx/Expanded-Armory-Legacy/build.yml?logo=githubactions&style=flat-square)](https://github.com/ThexXTURBOXx/Expanded-Armory-Legacy/actions/workflows/build.yml)
<!--[![CurseForge Downloads](https://img.shields.io/curseforge/dt/1033985?logo=curseforge&style=flat-square)](https://www.curseforge.com/minecraft/mc-mods/balkons-weaponmod-legacy)
[![Modrinth Downloads](https://img.shields.io/modrinth/dt/MCF15nCy?logo=modrinth&style=flat-square)](https://modrinth.com/mod/balkons-weaponmod-legacy)
[![Translate on Crowdin](https://img.shields.io/static/v1?label=Translate&message=on%20Crowdin&logo=crowdin&style=flat-square)](https://crowdin.com/project/balkons-weaponmod-legacy)-->
[![Sponsor me!](https://img.shields.io/github/sponsors/ThexXTURBOXx?logo=github&style=flat-square)](https://github.com/sponsors/ThexXTURBOXx)

Expanded Armory: Legacy is a simple mod, it takes the tool materials from other mods and brings them to Balkon's WeaponMod: Legacy.
This is [HyperSpeeed](https://nmexis.me/)'s modernisation fork of
the [original project](https://github.com/mallrat208/ExpandedArmory).

## Why?

Rest in Pieces, Expanded Armory!
This project is meant as a homage to our good old friend: Expanded Armory.
Nine years ago (at the time of writing this it is beginning-2025), the mod was abandoned.
As one of the two creators of Reforged, I wanted to pose a challenge to myself:
Directly port BWM and this gem of a mod to modern versions of Minecraft.

I am working full-time, so I can only dedicate a bit of my precious time to projects like this.
I hope you enjoy playing around with it!

Without anything further to say here, enjoy!

## Contributing

There are many ways to contribute!

### Development

Development should be rather easy. BWM: Legacy currently uses Loom in three different flavors:

- [Architectury Loom](https://github.com/architectury/architectury-loom) for everything above 1.16.5. It is the easiest
way to enable multi-platform modding and is officially endorsed by
the [Architectury API](https://github.com/architectury/architectury) (which this mod depends on in 1.16.5+).
- [Essential Loom](https://github.com/EssentialGG/architectury-loom) for all versions between 1.8.9 and 1.12.2. Sadly,
Architectury Loom does not officially support Minecraft versions that old. So,
the [Essential team](https://github.com/EssentialGG) added many fixes to Architectury Loom to support these legacy
versions.
- [My own Loom](https://github.com/ThexXTURBOXx/architectury-loom/tree/dev/1.6-1.7.10) for everything between and below.
Sadly, even Essential Loom is not even able to handle some of these other versions correctly. So, I forked it and
hence created a fourth fork layer of the official Loom - perfect! I added fixes and hacks to make Loom even
1.7.10-compatible and fixed a few additional bugs that I found in upstream versions; that's all.

This way, you don't have to worry about most of the background tasks.
If you want to change the mod's code, you can just do the following:

1. Clone the repo: `git clone https://github.com/ThexXTURBOXx/Expanded-Armory-Legacy.git`
2. Checkout the branch you want to work on, e.g., `git checkout 1.7.10`
3. Open `build.gradle` or `build.gradle.kts` (depending on which version you want to develop on) in your favorite IDE (I
am using IntelliJ IDEA and everything works fine here... Don't know about other IDEs, though!)
4. Your IDE should download and build some stuff. This might take quite some time...
5. Now, you should be able to change the code properly!

To test your changes, you can just do the following:

1. Run `gradlew build` to compile the mod
2. If everything worked fine, you should find the mod jar in either `build/libs/ExpandedArmory-forge-1.5.0.jar`
or `<PLATFORM>/build/libs/ExpandedArmory-<PLATFORM>-1.5.0.jar`

When you are done with your changes, push them to
a [fork](https://github.com/ThexXTURBOXx/Expanded-Armory-Legacy/fork) of my repository
and [open a PR](https://github.com/ThexXTURBOXx/Expanded-Armory-Legacy/compare/1.7.10...Sunconure11:ExpandedArmory:master)!
**Make sure to target my repository, not the upstream (original) Expanded Armory repository!**

<!--TODO
### Translation
This project uses [Crowdin](https://crowdin.com/project/balkons-weaponmod-legacy)!
If you want to translate the mod, feel free to change one of the existing languages there!
If you want to translate the mod to another language that I have not yet added there,
please [open an issue](https://github.com/ThexXTURBOXx/Balkons-WeaponMod-Legacy/issues/new) to ask me to add it there
first.-->

### Bug Reports and Feature Requests

If you find a bug or want to see something new in the mod, feel free to let me know by
[opening an issue](https://github.com/ThexXTURBOXx/Expanded-Armory-Legacy/issues/new)!

0 comments on commit 1489e27

Please sign in to comment.