Skip to content

Clone source and run cmod3 how to

Josep Llodrà edited this page Mar 4, 2016 · 15 revisions

Step by step:

Use git to clone the repository, or the download ZIP button from github.

git clone --depth 1 https://github.com/jllodra/cmod3.git

It will create the directory "cmod3".

Download and install dependencies

cd cmod3/src
npm install

Output:
[email protected] /Users/.../cmod3/src
├─┬ [email protected]
│ ├─┬ [email protected]
│ │ ├─┬ [email protected]
...

For this to work, you need to have "nodejs" installed. Npm is bundled with nodejs. There are a lot of ways to get nodejs, depending on your OS. Please take your time to find out and google what the best option is for you.

bower install

Output:
bower angular-ui-router#~0.2.15 cached git://github.com/angular-ui/ui-router.git#0.2.15
bower angular-ui-router#~0.2.15 ...
...

For this to work, you have to install "bower" first (npm install -g bower).

Download nw.js

From http://nwjs.io/, I'm using version 0.12.3 (on OSX, but you can download the version for Win and Linux).

I recommend unzipping it in a directory different than "cmod3", I have it one directory below (named cache):

../cache/0.12.3/

See the file "start.sh", this is the bash script that I use to start the program.

### Start cmod3

I run my script ./start.sh, but you can run your own command, you have to run the nwjs binary followed by the path for cmod3/src.

Please, open an issue if you have any problem.

### Please note...

  • Ctrl+0 opens the developer console.
  • Comment lines 12 & 14 from index.html to make console.* messages appear.
  • The API key for modarchive is missing and is only bundled with cmod3 binaries, so you won't be able to browse modarchive (an exception happens, I should handle that)...
  • The official NW.JS comes without the mp3 decoding libraries (they are not opensource), you have to add them manually in order to be able to play Nectarine (otherwise you'll hear nothing)! Use google to find out how to do this.
  • Beside that... regular .IT/.XM/.S3M/.MOD playback has to work :)
  • I'm going to write another wiki page about building.