Skip to content

Latest commit

 

History

History
87 lines (56 loc) · 2.37 KB

README.md

File metadata and controls

87 lines (56 loc) · 2.37 KB

🏔️ Terren 🗺️

Welcome to Terren, an innovative open-source project that empowers voxel terrain generation and visualization right from your browser. 🌍

📋 Description

Terren harnesses the power of procedural generation, combining rules and noise maps to craft unique voxel terrains. Whether you’re a seasoned developer, a creative enthusiast, or simply curious about the art of world-building, Terren provides a user-friendly platform to unleash your imagination.

With Terren, you’re not limited to pre-defined landscapes – import your own noise maps to generate terrains that reflect your vision.

[!NOTE] > (coming soon)

Export your creations as images, .glb models for use in 3D applications, or JSON configurations for seamless integration into your projects.

🚀 Demo

terren.grusz.dev

🛠️ Tech Stack

Framework: Next.js, React, TypeScript

UI: @shadcn-ui, TailwindCSS, SCSS, Framer Motion

3D Rendering: Three.js, @react-three/fiber

▶️ Running Locally

  1. Clone the repository
git clone https://github.com/tomasgrusz/terren.git
  1. Navigate to project folder
cd terren
  1. Install all dependencies
npm install
# or
yarn install
# or
bun install
  1. Run the development environment
npm run dev
# or
yarn dev
# or
bun dev
  1. Open http://localhost:3000 within your browser

🫂 Contributing

All contributions from the community are welcome! If you have a tool, library, or resource that you believe would be valuable to others, please follow these steps to contribute:

  1. Fork the repository
  2. Create a new branch git checkout -b new-feature
  3. Add your contribution
  4. Commit your changes git commit -am 'Add new feature'
  5. Push to the branch git push origin new-feature
  6. Create a new Pull Request

🛡️ License

Terren is licensed under the GNU General Public License v3.0. See the LICENSE file for details.

👍 Feedback

Have questions or feedback? Create a Github Discussion or drop us an email at [email protected].

Happy mapping! 🎨🌟