Minecolonies Style Explorer

This is a small and unofficial web app to view organized screenshots of the buildings from the Minecolonies Minecraft mod.

Features

• View screenshots of various buildings from the Minecolonies mod
• Organized and categorized for easy exploration
• Search by building names etc
• Responsive design for accessibility on different devices

Tech/Libraries etc

• Vite
• tailwindcss
• shadcn/ui
• Jotai
• Blurhash
• prismarine-nbt

Prerequisites

• Node.js and pnpm installed on your local machine

Installation

1. Clone the repository:

   git clone https://github.com/tomp2/minecolonies-style-explorer.git

2. Navigate to the project directory:

   cd minecolonies-style-explorer

3. Install dependencies:

   pnpm install

Running the App

To start the development server, run:

pnpm run dev

This will start the app and you can access it at http://localhost:5173

Continuous Deployment

The project uses GitHub Actions (workflow defined in.github/workflows/deploy.yml) to build and deploy the project automatically to Github Pages when something is pushed to the main branch.

Contributing

1. Fork the repository
2. Create a new branch (git checkout -b feature-branch)
3. Make your changes
4. Commit your changes (git commit -m 'Add some feature')
5. Push to the branch (git push origin feature-branch)
6. Open a pull request

Acknowledgments❤️

• Minecolonies - The Minecraft mod and the builders