Create customizable 3D city model applications for the browser using only configuration files.
This project extends Cesium.js with an easy-to-use setup that lets you define data, appearance, and functionality primarily through config files, HTML, and CSS — no backend required.
A full working example can be found here
Requires NPM version 10.9.0 or higher.
This application is available as a GitHub repository.
The option to download prebuilt source files will be available soon.
For detailed technical documentation and API reference, look here (generated with Typedoc).
After cloning the repository, open a terminal and change into the project directory and execute the following command. This will install all necessary packages under node_modules.
npm i
This project uses vite as a bundler and http server for development. Vite's behavior can be configured via vite.config.js.
npm run dev
Starts a server running the application in development mode (hot modules replacement, faster rebuilds, etc.). In your console output, you can see the actual url it's running on (e.g. localhost:5173)
npm run preview
Starts a server running the application in production mode (produciton-optimized). In your console output, you can see the actual url it's running on (e.g. localhost:5174)
npm run build --mode ENVIRONMENT_NAME
Builds and bundles all source files into the dist output directory. These files match the prebuilt source files from the github repo and can be served by a http server. ENVIRONMENT_NAME should be replaced by the actual environment name one wants to build. If --mode is not used, vite will look for .env, .env.production, .env.local and .env.production.local in that specific order.
npx typedoc
Builds the documentation files and puts them in the documents folder.
npm run docs
Serves the generated documentation from the docs folder.
For detailed usage, check the docs folder.
Configurable vs. Hard-Coded Parts
Prebuilt Files Coming Soon
Legacy Code