Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shijbey/infiniforge
Typescript library for procedurally generating 3D fantasy swords.
https://github.com/shijbey/infiniforge
3d-models fantasy game-development gltf mesh pcg procedural-generation threejs typescript
Last synced: 3 months ago
JSON representation
Typescript library for procedurally generating 3D fantasy swords.
- Host: GitHub
- URL: https://github.com/shijbey/infiniforge
- Owner: ShiJbey
- License: mit
- Created: 2016-07-06T13:26:29.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-07-20T04:18:25.000Z (over 1 year ago)
- Last Synced: 2024-04-14T05:11:03.902Z (9 months ago)
- Topics: 3d-models, fantasy, game-development, gltf, mesh, pcg, procedural-generation, threejs, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/infiniforge
- Size: 109 MB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Infiniforge
TypeScript library for procedurally generating 3D fantasy swords using ThreeJS.
This project was originally made as part of the August 2016 Reddit procedural generation challenge
Found here: [Reddit Challenge](https://www.reddit.com/r/proceduralgeneration/comments/4wubjy/monthly_challenge_9_august_2016_procedural_weapons/)
## Installation
```bash
npm install infiniforge
```
This package has `three` and `lodash` as peer dependencies.
So, those will need to be installed too.
## Usage
The code below imports the infiniforge library, generates
a new sword model and writes it to local disk as a `*.gltf`
file. The `generate` function takes a `SwordGenerationParams`
object that specifies fields that affect the generator's
behavior. Here we specify that we want the output to be
glTF and we want the style of sword to be a long sword.
Please refer to [this typescript file](https://github.com/ShiJbey/Infiniforge/blob/develop/src/infiniforge/core/generators/sword/SwordGenerationParams.ts)
for the most comprehensive list of generator params.
```javascript
// Generate random sword and write it to a file
const fs = require("fs");
const infiniforge = require("infiniforge");
const swordGenerator = new infiniforge.SwordGenerator();
swordGenerator
.generate({
output: "gltf",
style: "long",
})
.then((sword) => {
try {
fs.writeFileSync("sword.gltf", JSON.stringify(sword));
} catch (err) {
console.error(err);
}
})
.catch(console.error);
```
## Building the Documentation
The documentation is generated using [Typedoc](https://typedoc.org):
```bash
npm run build:docs
```
## Frequently asked questions
### What is glTF?
Infiniforge exports 3D meshes as JSON in the
glTF 2.0 (GL Transmission Format ) by Khronos Group. It is a royalty-free
specification for the efficient transmission and loading of 3D scenes and
models by applications. The spec is available [here](https://www.khronos.org/gltf/ "glTF Overview").
This application uses a modified version of the GLTFExporter provided
with [ThreeJS](https://threejs.org/docs/#examples/exporters/GLTFExporter).
### What can I do with this?
Infiniforge output can be saved as a \*.gltf file and used in a multitude of projects. Various importers are
available from [Khronos Group](https://www.khronos.org/gltf/). For example, one could use this
in a unity game by taking advantage of the [UnityGLTF plugin](https://github.com/KhronosGroup/UnityGLTF). Also, glTF files can also be opened on windows 10 using the 3D Viewer application.
## References
- [https://en.wikipedia.org/wiki/Longsword](https://en.wikipedia.org/wiki/Longsword)
- [http://www.lordsandladies.org/middle-ages-weapons.htm](http://www.lordsandladies.org/middle-ages-weapons.htm)
- [https://www.medievalswordsworld.com/](https://www.medievalswordsworld.com/)