Sp0ne / simple-threejs-starter

Super Simple Three.js Starter with simple shaders and Tweakpane ui debugger for fast starting project.

Simple Three.js Starter

Simple Three.js boilerplate powered by Vite for fast experience starter.

🧪 v0.0.1 〢 Live Demo

---

---

📖 Features

• Node.js v14.19 min 📦
• Three.js v0.141.0 📦
• Powered with Vite 📦
• UI controls using Tweakpane 🎛
• Animate by GSAP
• Simple Shaders support (glsl) with vite-plugin-glsl 🎨
• Minimal Raycasting.
• Simple texture support / loader

---

💾 Installation

👇 Hit in your terminal for setup

# npm install
yarn

🥑 Usage 〢 Get Started

# Compiles & hot-reloads for development
# npm run dev
yarn dev

# Or Vite preview
# npm run serve
yarn serve

# Build & minifies for production
# npm run build
yarn build

# Deploy on Gh-pages
# npm run deploy
yarn deploy

App running at on localhost:9000/simple-threejs-starter/

⚙️ Config vite ⚡

Change config in vite.config.vue if you want:

export default defineConfig({
  base: '/simple-threejs-starter/', // Remove or Adapt it ! (it's just for GH-PAGES)
  // ...stuff...
  server: {
    port: 9000,                     // Default 9000: Adapt it !
  },
  // ...stuff...
})

Reminder 📦:

# update dependencies. need existing yarn.lock file.
yarn upgrade-interactive --latest

---

🐞 Bugs 〢 Contributing

First off, thanks for taking the time to contribute! 👍 !! The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests.

---

🍭 Credits 〢 </💻❤>

Originally written & currently maintained with by @Sp0ne🧙‍♂ © 2022

👋🏻: 🖥 vinces.io 〢 🐙 @Sp0ne 〢 🧪 codepen

---