Skip to content

Commit

Permalink
Add a note about the build process to README
Browse files Browse the repository at this point in the history
  • Loading branch information
lexisother committed Aug 22, 2023
1 parent c111638 commit 22c6d6f
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,22 @@ https://stronghold.openkrosskod.org/~dmitmel/ccloader3/

## Building from source

(This section may be moved in the future)

```bash
cd /somewhere/but/preferably/inside/the/crosscode/directory
git clone https://github.com/CCDirectLink/CCLoader3.git ccloader3
cd ccloader3
npm install
mv runtime/src/extension-preloader.ts .
npm run build
mv extension-preloader.ts runtime/src
npm run build
```

Yes, that moving about of the extension-preloader is intentional and required. It is a bug in how
TypeScript compiles files in alphabetical order, and the extension-preloader requires a file that
has not been built yet according to the alphabetical order. This will be fixed once the module
structure of the modloader is redone.

Then edit the game's `package.json` and point the path in the `main` field to the location of the
`main.html` page in the `ccloader3` directory.

Expand Down

0 comments on commit 22c6d6f

Please sign in to comment.