Skip to content

Commit

Permalink
added icons, fixed readme.md, fixed docs directory
Browse files Browse the repository at this point in the history
  • Loading branch information
devvyyxyz committed Oct 28, 2024
1 parent 43f3ae2 commit 1ff6c9a
Show file tree
Hide file tree
Showing 9 changed files with 544 additions and 7 deletions.
68 changes: 68 additions & 0 deletions Assets/BlackAndWhiteCreeper.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Assets/Creeper.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Assets/Dirt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Assets/DirtSide.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Assets/Mixed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
138 changes: 138 additions & 0 deletions DOCS/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
---
icon: code-of-conduct
label: Code of conduct
description:
layout: defualt
categories: [guide]
tags: [guide, codeofconduct, legal]
expanded: true
visibility: public
---
# 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, 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 e-mail 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
discord.
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.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
111 changes: 111 additions & 0 deletions DOCS/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
---
icon: commit
label: Uploading & contributing
description:
layout: defualt
categories: [guide]
tags: [guide]
expanded: true
visibility: public
---
# Uploading Mods via GitHub Pull Requests

To contribute your mods to this repository, you can submit a pull request using either the GitHub web interface or your local machine. Follow the steps below for your preferred method.

## :icon-globe: Using the Web Interface

1. **Fork the Repository**: Click the "Fork" button in the upper-right corner of this repository to create a personal copy in your GitHub account.
2. **Navigate to Your Fork**: Once forked, go to your forked repository on GitHub (it will be at `https://github.com/<your-username>/<repo-name>`).
3. **Create or Edit a File**:
- Click on the "Add file" button and choose "Create new file" to add a new mod.
- To edit an existing file, navigate to it, and click the pencil icon.
4. **Add Your Mod**: Add your mod code to the editor. Make sure it follows any style guidelines or contribution rules for the project.
5. **Commit Your Changes**: Scroll down to the "Commit new file" section:
- Enter a brief commit message that describes the mod or changes you’ve made.
- Optionally, provide more details in the extended description.
- Click "Commit new file" (or "Commit changes" if editing an existing file).
6. **Submit a Pull Request (PR)**:
- Navigate back to the original repository (not your fork).
- Click on "New Pull Request".
- Select the branch from your fork that contains your changes.
- Add a meaningful description of your mod, explaining its functionality or purpose, then submit the pull request.

## :icon-command-palette: Using Your Local Machine (Git & CLI)

1. **Fork the Repository**: Fork the original repository by clicking "Fork" in the upper-right corner to create a copy under your GitHub account.
2. **Clone Your Fork Locally**: Clone your forked repository to your local machine:
```bash
git clone https://github.com/<your-username>/<repo-name>.git
cd <repo-name>
```
3. **Create a New Branch**: Always create a separate branch for each mod or feature to keep things organized:
```bash
git checkout -b my-new-mod
```
4. **Add Your Mod Files**: Place your mod files in the appropriate directories (`Actions`, `Themes`, etc.). Ensure they follow any existing file structure or conventions.
5. **Commit Your Changes**: Once your mod is added, stage and commit the changes:
```bash
git add .
git commit -m "Add my new mod [describe what the mod does]"
```
6. **Push Changes to Your Fork**: Push the new branch to your forked GitHub repository:
```bash
git push origin my-new-mod
```
7. **Open a Pull Request (PR)**:
- Visit the original repository on GitHub.
- Click "New Pull Request".
- Select the branch from your fork that contains your mod.
- Add a detailed description, including what the mod does, why it's useful, and any special instructions for testing or using it. Then submit the PR.
## :icon-pencil: Important Notes
- **Testing**: Be sure to test your mod before submitting it. Ensure it works as expected and doesn’t introduce bugs or issues.
- **Branch Naming**: When creating a new branch, use a descriptive name that relates to the mod or feature, such as `add-action-mod` or `fix-theme-mod`.
- **Contributing Guidelines**: If this repository has a `CONTRIBUTING.md` file, make sure to read and follow it before submitting your pull request.
## :icon-repo: Useful Resources
Here are some helpful resources to assist you in contributing to this repository:
- **[Markdown Guide](https://www.markdownguide.org/)**: A comprehensive guide to Markdown, a lightweight markup language for formatting text. Learn how to structure your README files, documentation, and more.
- **[GitHub Octicons](https://primer.github.io/octicons/)**: GitHub's official icon set, commonly used across GitHub projects. Use these icons to enhance your repository's visual appeal.
- **[Retype Octicons](https://retype.com/components/octicons/#icon-list)**: A collection of GitHub Octicons that can be easily integrated into Retype-powered documentation, perfect for adding icons to enhance your documentation pages.
- **[GitHub Docs](https://docs.github.com/)**: The official GitHub documentation. Learn about GitHub features, commands, workflows, and tips for managing repositories, handling pull requests, and more.
- **[Pro Git Book](https://git-scm.com/book/en/v2)**: A free online book that covers everything you need to know about Git, from the basics to advanced topics like branching and Git workflows.
- **[GitHub Flow](https://docs.github.com/en/get-started/quickstart/github-flow)**: An explanation of the GitHub Flow, a lightweight, branch-based workflow that supports teams and projects in version control.
- **[Semantic Commit Messages](https://gist.github.com/joshbuchea/01f9d4aa31638a2b95b8)**: A guide to writing clear and concise commit messages using semantic conventions, which helps maintain an organized commit history.
- **[Learn Git Branching](https://learngitbranching.js.org/)**: An interactive Git learning game that helps you practice and understand Git branching, merging, and rebasing.
- **[GitHub CLI](https://cli.github.com/)**: GitHub’s command-line tool for managing pull requests, issues, and repositories directly from your terminal.
These resources will help you with everything from mastering Markdown to understanding Git workflows, writing better commit messages, and effectively using GitHub tools.
## Template page
[!ref](template.md)
+++ Code
:::code source="template.md" :::
+++ demo
## Welcome to the Template Page
This is a sample template page. You can use this as a starting point for creating new pages in your project.
### Table of Contents
- [Introduction](#introduction)
- [Usage](#usage)
- [Examples](#examples)
- [Conclusion](#conclusion)
### Introduction
Provide an introduction to the template page here. Explain the purpose and any relevant background information.
### Usage
Describe how to use this template. Include any necessary steps or instructions.
### Examples
Provide examples of how this template can be used. Include code snippets or screenshots if applicable.
### Conclusion
Summarize the key points of the template page. Include any final thoughts or recommendations.
Feel free to customize this template to fit your needs.
+++
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,23 +82,32 @@ This repository hosts a collection of Minecraft texture packs, mods, and data pa
To make setup easier, we’ve provided auto-installation scripts for Windows and Linux. These scripts will automatically download and place the selected texture packs, mods, or data packs in the correct directories.

### 🖥️ Windows (Batch Script)

1. Download the install.bat file from this repository.
2. Run the install.bat file by double-clicking it.
3. Follow the prompts to select the resources you want to install.
The script will automatically:
The script will automatically:

• Download selected resources

• Move texture packs to .minecraft/resourcepacks

• Move mods to .minecraft/mods

• Move data packs to the selected world’s datapacks folder

### 🐧 Linux (Bash Script)
1. Download the install.sh file from this repository.
2. Open a terminal and navigate to the download location.
3. Run the following commands:
ʼʼʼ

1. Download the install.sh file from this repository.
2. Open a terminal and navigate to the download location.
3. Run the following commands:

```
chmod +x install.sh
./install.sh
ʼʼʼ
4. Follow the prompts to select the resources you want to install.
```

4. Follow the prompts to select the resources you want to install.

## ⚖️ Legal Disclaimer

Expand Down
Loading

0 comments on commit 1ff6c9a

Please sign in to comment.