You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
DCollage is a lightly opinionated PIXIJS based digital collage boilerplate with game dev aspirations and a component driven paradigm written in TypeScript.
7
6
The goal of DCollage is to facilitate the creation of multi-layered, interactive, collages similar to those I created back in the days of Flash. Surprise it works for simple games too!
8
7
@@ -16,26 +15,33 @@ Your project description may appear here.
16
15
17
16
DCollage is meant to get you up and running with a PIXI app in minutes. While there are a lot of nuances that can be tweaked and you are not forced to follow the patterns this boilerplate includes it should be a matter of clone, install, run.
-[Patterns and Cookbook page](https://github.com/jrod-disco/dcollage-pixijs-boilerplate/wiki/Patterns-and-Cookbook)
22
+
- Check out the branch `simple-game` for a good starting poit for a game project
23
+
19
24
## Clone or Template
20
25
21
-
- Clone or spin up a new repo using the github template `https://github.com/jrod-disco/dcollage-pixijs-boilerplate.git`
26
+
- Clone or spin up a new repo using `https://github.com/JRVisuals/dcollage-pixijs-boilerplate`
22
27
23
28
## Install and Run
24
29
25
-
- Run `yarn install` at the project root to install all of the `node_modules`
26
-
- Run `yarn start` to begin developing locally `http://localhost:10001/`
30
+
- Run `yarn` at the project root to install all of the `node_modules`
31
+
- Run `yarn dev` to begin developing locally `http://localhost:10001/`
27
32
28
-
## Have Fun!
33
+
## Basic Setup
29
34
30
35
- Set the `APP_HEIGHT` and `APP_WIDTH` in `constants/index.ts`
31
-
- Edit `main.ts` to add or remove components from the main container
36
+
- Edit `core.ts` to add or remove components from the main container
37
+
- Set up any screens that you need
32
38
- There is a `components/library` included to help you get started (please contribute yours back to the repo and namespace their directory E.g. `components/library/yourGithubUsername`)
33
-
- Put your assets in `./src/assets` and add anything you want to preload to the `preloader` at the bottom of `main.ts`
39
+
- Put your assets in `./src/assets` and add anything you want to preload to the `preloader`component and at the bottom of `core.ts`
34
40
- Use any of the `components/library` components, or make your own
35
41
36
42
# Build Scripts
37
43
38
-
-`yarn start` to go into development mode with live reload
44
+
-`yarn dev` to go into development mode with live reload
39
45
-`yarn clean` to clean the `/dist` directory
40
46
-`yarn build` to create a distributable bundle in `/dist`
41
47
-`yarn docs` to generate markdown documentation in `/docs`
@@ -45,36 +51,14 @@ DCollage is meant to get you up and running with a PIXI app in minutes. While th
45
51
- possible values: `win-x86,win-x64,linux-x86,linux-x64,mac-x64`
46
52
-`yarn all-the-things` to `clean`, `build` and `nwjs-dist`
47
53
48
-
# Dev Tools for PIXI
49
-
50
-
-[Pixi.js devtools Chrome Extension](https://chrome.google.com/webstore/detail/pixijs-devtools/aamddddknhcagpehecnhphigffljadon?hl=en) shows up in your Chrome Dev Tools Panel and can be super helpful - this is why we will usually name our containers w/ `container.name='foo'`
51
-
52
-
## Concept and Mechanics
53
-
54
-
TBD
54
+
## Demo Branches
55
55
56
-
## Roadmap
56
+
- Check out the branch `simple-game` for a good starting poit for a game project
57
+
- Will be adding other starting branches as we go
57
58
58
-
-[ ] Bootstrap DCollage Boilerplate for PIXI.JS
59
-
60
-
-[ ] clone this repo or spin up a repo via github template
61
-
-[ ] yarn install
62
-
-[ ] yarn dev
63
-
64
-
-[ ] Learn how to use it
65
-
66
-
-[ ] Peep the [wiki](https://github.com/jrod-disco/dcollage-pixijs-boilerplate/wiki)
67
-
-[ ] Especially the [Patterns and Cookbook page](https://github.com/jrod-disco/dcollage-pixijs-boilerplate/wiki/Patterns-and-Cookbook)
68
-
-[ ] Cruise through the example code
69
-
70
-
-[ ] Make cool stuff
71
-
-[ ] Have fun doing it
72
-
73
-
### Completed!
74
-
75
-
-[x] Discover DCollage Boilerplate for PIXI.JS
59
+
# Dev Tools for PIXI
76
60
77
-
-[x] Read the readme
61
+
-[Pixi.js devtools Chrome Extension](https://chrome.google.com/webstore/detail/pixijs-devtools/aamddddknhcagpehecnhphigffljadon?hl=en) shows up in your Chrome Dev Tools Panel and can be super helpful - this is why we will usually name our containers w/ `container.name='foo'`
0 commit comments