Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation and getting started guide #12

Open
16 tasks
Lotnest opened this issue Jan 30, 2025 · 0 comments
Open
16 tasks

Documentation and getting started guide #12

Lotnest opened this issue Jan 30, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation high Tasks that are urgent and need to be addressed as soon as possible

Comments

@Lotnest
Copy link
Contributor

Lotnest commented Jan 30, 2025 •
edited
Loading

Description: We need to create proper documentation and a comprehensive guide on how to get started with the project. This will help new contributors and users understand how to set up and work with our Minecraft mod, which runs on Architectury and supports both Fabric and NeoForge.

Project overview:

  • Brief introduction to the project.
  • Key features and functionalities of the mod.
  • Information on Architectury and its role in the project.
  • Explanation of Fabric and NeoForge support.

Prerequisites:

  • List of required software and tools (e.g., Java Development Kit, Minecraft, Fabric/NeoForge, IDEs like IntelliJ IDEA).
  • Links to download the required software.

Setting up the development environment:

  • Step-by-step instructions to clone the repository.
  • Guide to setting up the project in popular IDEs (IntelliJ IDEA, Eclipse).
  • Instructions to install and configure Fabric and NeoForge.

Building the project:

  • Commands and scripts to build the project.
  • Explanation of the build process.

Running the mod:

  • Instructions to run the mod in a local Minecraft instance.
  • Troubleshooting tips for common issues.

Contributing guidelines:

  • How to fork the repository and create a new branch.
  • Coding standards and best practices.
  • How to create pull requests and the review process.

References:
Architectury Documentation
Fabric Documentation
NeoForge Documentation
@Lotnest Lotnest added the documentation Improvements or additions to documentation label Jan 30, 2025
@Lotnest Lotnest changed the title Documentation Documentation and getting started guide Jan 30, 2025
@Lotnest Lotnest added the high Tasks that are urgent and need to be addressed as soon as possible label Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation high Tasks that are urgent and need to be addressed as soon as possible
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Lotnest