Skip to content

Commit

Permalink
Include THREE.js and dependencies in the project
Browse files Browse the repository at this point in the history
  • Loading branch information
typpo committed Aug 10, 2019
1 parent 5d4a268 commit a8347ce
Show file tree
Hide file tree
Showing 31 changed files with 53,793 additions and 5,405 deletions.
21 changes: 14 additions & 7 deletions README.md
Expand Up @@ -112,20 +112,27 @@ sim.createSphere('earth', {
```
`KeplerParticles`: an optimized class for creating many particles that follow Kepler orbits. These particles don't have a specific shape or size. Instead, they share a 2D texture. This is useful for when you want to show many objects at once, such as the asteroid belt.
# How to get started
To be written...
# Dependencies
You'll need to include the following dependencies in production:
Spacekit relies on some image and data assets that are not included in the Javascript file.
By default, these dependencies are hosted on the spacekit site (typpo.github.io/spacekit). If you want to host these assets yourself, you can set the `Simulation`'s `basePath` parameter to a folder that contains these files:
- [Spacekit asset directory](https://github.com/typpo/spacekit/tree/master/src/assets)
- [Spacekit data directory](https://github.com/typpo/spacekit/tree/master/src/data)
For example:
- THREE.js
- THREE.js TrackballControls
- Stats.js (optional)
- Spacekit asset directory [TODO: link to asset and data file]
- Spacekit data directory
```
const viz = new Spacekit.Simulation({
basePath: 'https://mysite.com/static/spacekit',
});
```
If you want to contribute to this project, you will also need to install Python (2.7 or 3).
Expand Down

0 comments on commit a8347ce

Please sign in to comment.