Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shrjrd/rbxcad
roblox-typescript port of JSCAD (CSG in JavaScript)
https://github.com/shrjrd/rbxcad
2d-design 3d-design constructive-solid-geometry csg lua luau modular roblox roblox-ts typescript
Last synced: 6 days ago
JSON representation
roblox-typescript port of JSCAD (CSG in JavaScript)
- Host: GitHub
- URL: https://github.com/shrjrd/rbxcad
- Owner: shrjrd
- License: mit
- Created: 2025-01-14T01:25:34.000Z (7 days ago)
- Default Branch: main
- Last Pushed: 2025-01-14T05:39:27.000Z (7 days ago)
- Last Synced: 2025-01-14T06:34:43.345Z (7 days ago)
- Topics: 2d-design, 3d-design, constructive-solid-geometry, csg, lua, luau, modular, roblox, roblox-ts, typescript
- Language: TypeScript
- Homepage:
- Size: 386 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# rbxtscad
>Solid Modelling Library for 2D and 3D Geometries
>[jscad/[email protected]](https://github.com/jscad/OpenJSCAD.org/tree/master/packages/modeling) ported to [roblox-ts](https://github.com/roblox-ts/roblox-ts)
> [!NOTE]
> Work in progress, check TODO
## Overview
This library contains boolean operations based on Constructive Solid Geometry (CSG). CSG is a modelling technique that uses boolean operations like union and intersection to combine 3D solids. This library implements CSG operations on meshes elegantly and concisely using BSP trees, and is meant to serve as an easily understandable implementation of the algorithm.
## Building from source
```bash
npm install
rbxtsc --verbose
rojo build default.project.json -o Place.rbxl
```
## Installation as package
```bash
```
## Documentation
- [API Reference](https://openjscad.xyz/docs/)
- [JSCAD User Guide](https://openjscad.xyz/guide.html)
## Running Tests
> [!NOTE]
> Jest Lua depends on `debug.loadmodule` (`FFlagEnableLoadModule`) to run tests.
To run unit tests, build default.project.json then start a playtest session in [Run Mode](https://create.roblox.com/docs/studio/testing-modes#playtest-options) (`F8`).
## Copyrights
Some copyrights apply from integration of original libraries.
CSG Library : Copyright (c) 2012 Joost Nieuwenhuijse, under the MIT license. Copyright (c) 2011 Evan Wallace, under MIT license.
Portions of glMatrix Library: Copyright (c) 2015-2020, Brandon Jones, Colin MacKenzie IV, under MIT license.
Quickhull Library: Copyright (c) 2015 Mauricio Poppe, under the MIT license.
---
This project is released under the MIT License.
[](LICENSE.md)