Merge branch 'develop' into carolstone-chron-run-early-issue-4488
6
.codeclimate.yml
Normal file
@@ -0,0 +1,6 @@
|
||||
languages:
|
||||
JavaScript: true
|
||||
|
||||
exclude_paths:
|
||||
- "database_reports/*"
|
||||
- "migrations/*"
|
||||
2
.gitignore
vendored
@@ -5,7 +5,7 @@ node_modules
|
||||
*.swp
|
||||
.idea*
|
||||
config.json
|
||||
npm-debug.log
|
||||
npm-debug.log*
|
||||
lib
|
||||
website/public/bower_components
|
||||
website/public/new-stuff.html
|
||||
|
||||
@@ -7,6 +7,8 @@
|
||||
"node": true,
|
||||
"mocha": true,
|
||||
|
||||
"esnext": true,
|
||||
|
||||
"asi": true,
|
||||
"boss": true,
|
||||
"newcap": false
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
[Please see these instructions for reporting bugs](https://github.com/HabitRPG/habitrpg/issues/2760)
|
||||
|
||||
## Frequently Asked Questions
|
||||
You might find help with your issue on the [Frequently Asked Questions](http://habitrpg.wikia.com/wiki/FAQ) page.
|
||||
You might find help with your issue on the [Frequently Asked Questions](http://habitica.wikia.com/wiki/FAQ) page.
|
||||
|
||||
# Requesting a feature
|
||||
|
||||
HabitRPG uses [Trello](https://trello.com/b/EpoYEYod/habitrpg) to track feature requests. [Read more](https://trello.com/c/odmhIqyW/440-read-first-table-of-contents).
|
||||
Habitica uses [Trello](https://trello.com/b/EpoYEYod/habitica) to track feature requests. [Read more](https://trello.com/c/odmhIqyW/440-read-first-table-of-contents).
|
||||
|
||||
# Contributing Code
|
||||
|
||||
See [Contributing to HabitRPG](http://habitrpg.wikia.com/wiki/Contributing_to_HabitRPG#Coders_.28Web_.26_Mobile.29)
|
||||
See [Contributing to Habitica](http://habitica.wikia.com/wiki/Contributing_to_Habitica#Coders_.28Web_.26_Mobile.29)
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# HabitRPG Docs Project
|
||||
# Habitica Docs Project
|
||||
|
||||
Generated documentation for all of HabitRPG's source files will be kept in the folder and subfolders. If you would like to use the existing documentation, or contribute to the documentation efforts, read on.
|
||||
Generated documentation for all of Habitica's source files will be kept in the folder and subfolders. If you would like to use the existing documentation, or contribute to the documentation efforts, read on.
|
||||
|
||||
## Viewing Docs
|
||||
|
||||
@@ -10,7 +10,7 @@ Unless you are viewing this file directly from GitHub, you should see a list of
|
||||
|
||||
If you are working locally, you can goto `localhost:3000/docs/` and view the Docs.
|
||||
|
||||
All documentation is generated from comments in the code, into HTML files in the `public/docs/` folder. After you have cloned the HabitRPG repo locally, and done all the `npm install` goodness, the Docs should generate automagickly when you run `grunt run:dev`
|
||||
All documentation is generated from comments in the code, into HTML files in the `public/docs/` folder. After you have cloned Habitica's repo locally, and done all the `npm install` goodness, the Docs should generate automagickly when you run `grunt run:dev`
|
||||
|
||||
## What I do now?
|
||||
|
||||
@@ -39,9 +39,9 @@ The exception being end of line comments
|
||||
|
||||
The above will not be on the "pretty print" side of the Docs, but will stay in the code. An example use case for end of line comments would be for FIXME notes.
|
||||
|
||||
Add anything that would be helpful to a developer regarding how to use the functions, variables, and objects associated with HabitRPG.
|
||||
Add anything that would be helpful to a developer regarding how to use the functions, variables, and objects associated with Habitica.
|
||||
|
||||
**All documentation should be committed as pull request to the `docs-project` branch of HabitRPG.** Since we are adding comments directly to the code, I don't want to be editing files used for beta or master. We can merge in the docs after we're sure we didn't break anything.
|
||||
**All documentation should be committed as pull request to the `docs-project` branch of Habitica's repo.** Since we are adding comments directly to the code, I don't want to be editing files used for beta or master. We can merge in the docs after we're sure we didn't break anything.
|
||||
|
||||
### jsDoc Syntax
|
||||
|
||||
@@ -52,7 +52,7 @@ Yes, the generator also supports jsDoc-style comments such as
|
||||
|
||||
**Important Note:** If you use the `@param` syntax, you must use multiline comment blocks (ie `/* stuff */`), otherwise they won't be parsed like parameters.
|
||||
|
||||
This may or may not be useful for HabitRPG. Example use cases:
|
||||
This may or may not be useful for Habitica. Example use cases:
|
||||
- Documenting the API
|
||||
- Javascript Models
|
||||
|
||||
@@ -60,7 +60,7 @@ This may or may not be useful for HabitRPG. Example use cases:
|
||||
|
||||
If you're running locally, just re-run `grunt run:dev`. Any changed docs will be automagickly updated.
|
||||
|
||||
Once you're satisfied with the output, push your changes to your fork of HabitRPG and issue a Pull Request on the `docs-project` branch.
|
||||
Once you're satisfied with the output, push your changes to your fork of the repo and issue a Pull Request on the `docs-project` branch.
|
||||
|
||||
It's that easy!
|
||||
|
||||
@@ -72,6 +72,6 @@ We also use the [Grunt-Docker](https://github.com/Prevole/grunt-docker) node mod
|
||||
|
||||
## Road Map
|
||||
|
||||
- Customize CSS with HabitRPG specific Styling
|
||||
- Customize CSS with Habitica-specific Styling
|
||||
- Explore possibilities of importing Wiki content
|
||||
- Specify style guide for consistency of comments
|
||||
20
Gruntfile.js
@@ -169,7 +169,7 @@ module.exports = function(grunt) {
|
||||
|
||||
watch: {
|
||||
dev: {
|
||||
files: ['website/public/**/*.styl', 'common/script/**/*.coffee'], // 'public/**/*.js' Not needed because not in production
|
||||
files: ['website/public/**/*.styl', 'common/script/**/*.coffee', 'common/script/**/*.js'], // 'public/**/*.js' Not needed because not in production
|
||||
tasks: [ 'build:dev' ],
|
||||
options: {
|
||||
nospawn: true
|
||||
@@ -224,8 +224,8 @@ module.exports = function(grunt) {
|
||||
|
||||
// Register tasks.
|
||||
grunt.registerTask('compile:sprites', ['clean:sprite', 'sprite', 'imagemin', 'cssmin']);
|
||||
grunt.registerTask('build:prod', ['loadManifestFiles', 'clean:build', 'browserify', 'uglify', 'stylus', 'cssmin', 'copy:build', 'hashres','prepare:staticNewStuff']);
|
||||
grunt.registerTask('build:dev', ['browserify', 'stylus', 'prepare:staticNewStuff']);
|
||||
grunt.registerTask('build:prod', ['loadManifestFiles', 'clean:build', 'browserify', 'uglify', 'stylus', 'cssmin', 'copy:build', 'hashres']);
|
||||
grunt.registerTask('build:dev', ['browserify', 'stylus']);
|
||||
grunt.registerTask('build:test', ['test:prepare:translations', 'build:dev']);
|
||||
|
||||
grunt.registerTask('run:dev', [ 'build:dev', 'concurrent' ]);
|
||||
@@ -239,20 +239,6 @@ module.exports = function(grunt) {
|
||||
"window.env.translations = " + JSON.stringify(i18n.translations['en']) + ';');
|
||||
});
|
||||
|
||||
grunt.registerTask('prepare:staticNewStuff', function() {
|
||||
var jade = require('jade'),
|
||||
fs = require('fs');
|
||||
fs.writeFileSync(
|
||||
'./website/public/new-stuff.html',
|
||||
jade.compileFile('./website/views/shared/new-stuff.jade')()
|
||||
);
|
||||
});
|
||||
|
||||
if(process.env.NODE_ENV == 'production')
|
||||
grunt.registerTask('default', ['build:prod']);
|
||||
else
|
||||
grunt.registerTask('default', ['build:dev']);
|
||||
|
||||
// Load tasks
|
||||
grunt.loadNpmTasks('grunt-browserify');
|
||||
grunt.loadNpmTasks('grunt-contrib-uglify');
|
||||
|
||||
2
Procfile
@@ -1 +1 @@
|
||||
web: ./node_modules/.bin/grunt nodemon;
|
||||
web: node ./website/src/server.js
|
||||
|
||||
10
README.md
@@ -1,12 +1,12 @@
|
||||
HabitRPG [](https://travis-ci.org/HabitRPG/habitrpg) [](https://codeclimate.com/github/HabitRPG/habitrpg) [](https://coveralls.io/r/HabitRPG/habitrpg?branch=develop) [](https://www.bountysource.com/trackers/68393-habitrpg?utm_source=68393&utm_medium=shield&utm_campaign=TRACKER_BADGE) [](https://gemnasium.com/HabitRPG/habitrpg)
|
||||
Habitica [](https://travis-ci.org/HabitRPG/habitrpg) [](https://codeclimate.com/github/HabitRPG/habitrpg) [](https://coveralls.io/r/HabitRPG/habitrpg?branch=develop) [](https://www.bountysource.com/trackers/68393-habitrpg?utm_source=68393&utm_medium=shield&utm_campaign=TRACKER_BADGE) [](https://gemnasium.com/HabitRPG/habitrpg)
|
||||
===============
|
||||
|
||||
[HabitRPG](https://habitrpg.com) is an open source habit building program which treats your life like a Role Playing Game. Level up as you succeed, lose HP as you fail, earn money to buy weapons and armor.
|
||||
[Habitica](https://habitica.com) is an open source habit building program which treats your life like a Role Playing Game. Level up as you succeed, lose HP as you fail, earn money to buy weapons and armor.
|
||||
|
||||
We need more programmers! Your assistance will be greatly appreciated.
|
||||
|
||||
For an introduction to the technologies used and how the software is organised, refer to [Contributing to HabitRPG](http://habitrpg.wikia.com/wiki/Contributing_to_HabitRPG#Coders_.28Web_.26_Mobile.29) - "Coders (Web & Mobile)" section.
|
||||
For an introduction to the technologies used and how the software is organised, refer to [Contributing to Habitica](http://habitica.wikia.com/wiki/Contributing_to_Habitica#Coders_.28Web_.26_Mobile.29) - "Coders (Web & Mobile)" section.
|
||||
|
||||
To set up a local install of HabitRPG for development and testing, see [Setting up HabitRPG locally](http://habitrpg.wikia.com/wiki/Setting_up_HabitRPG_locally), which contains instructions for Windows, *nix / Mac OS, and Vagrant.
|
||||
To set up a local install of Habitica for development and testing, see [Setting up Habitica Locally](http://habitica.wikia.com/wiki/Setting_up_Habitica_Locally), which contains instructions for Windows, *nix / Mac OS, and Vagrant.
|
||||
|
||||
Then read [Guidance for Blacksmiths](http://habitrpg.wikia.com/wiki/Guidance_for_Blacksmiths) for additional instructions and useful tips.
|
||||
Then read [Guidance for Blacksmiths](http://habitica.wikia.com/wiki/Guidance_for_Blacksmiths) for additional instructions and useful tips.
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
# Vagrant #
|
||||
|
||||
Vagrant is a system to create reproducible and portable development
|
||||
environments. Because of the variety of systems used for HabitRPG
|
||||
environments. Because of the variety of systems used for Habitica
|
||||
development and the various issues developers may encounter setting up
|
||||
HabitRPG on them, vagrant provides a single development enviroment with
|
||||
Habitica on them, vagrant provides a single development enviroment with
|
||||
minimal dependencies on the developer's local platform. It can be used
|
||||
on a variety of systems including Windows, Mac OS X, and Linux.
|
||||
|
||||
Instructions for using the HabitRPG Vagrant environment are in
|
||||
[Setting up HabitRPG locally](http://habitrpg.wikia.com/wiki/Setting_up_HabitRPG_locally).
|
||||
Instructions for using the Habitica Vagrant environment are in
|
||||
[Setting up Habitica Locally](http://habitica.wikia.com/wiki/Setting_up_Habitica_Locally).
|
||||
|
||||
50
bower.json
@@ -14,34 +14,34 @@
|
||||
"tests"
|
||||
],
|
||||
"dependencies": {
|
||||
"jquery": "~2.1.0",
|
||||
"jquery.cookie": "~1.4.0",
|
||||
"Angular-At-Directive": "snicker/Angular-At-Directive#c27bae207aa06d1e",
|
||||
"BrowserQuest": "browserquest/BrowserQuest#c3a960b03031dad5d",
|
||||
"angular": "1.3.9",
|
||||
"angular-ui": "~0.4.0",
|
||||
"angular-sanitize": "1.3.9",
|
||||
"angular-bootstrap": "0.13.0",
|
||||
"angular-filter": "0.5.1",
|
||||
"angular-loading-bar": "0.6.0",
|
||||
"angular-resource": "1.3.9",
|
||||
"angular-ui-utils": "~0.1.0",
|
||||
"angular-ui-select2": "git://github.com/angular-ui/ui-select2.git",
|
||||
"angular-bootstrap": "~0.13.0",
|
||||
"angular-loading-bar": "~0.6.0",
|
||||
"bootstrap": "~3.1.0",
|
||||
"bootstrap-growl": "git://github.com/ifightcrime/bootstrap-growl.git#master",
|
||||
"bootstrap-tour": "~0.10.1",
|
||||
"BrowserQuest": "git://github.com/browserquest/BrowserQuest.git",
|
||||
"github-buttons": "git://github.com/mdo/github-buttons.git",
|
||||
"marked": "~0.2.9",
|
||||
"Angular-At-Directive": "git://github.com/snicker/Angular-At-Directive#master",
|
||||
"js-emoji": "git://github.com/snicker/js-emoji#master",
|
||||
"sticky": "*",
|
||||
"swagger-ui": "git://github.com/wordnik/swagger-ui.git#v2.0.24",
|
||||
"angular-sanitize": "1.3.9",
|
||||
"angular-ui": "0.4.0",
|
||||
"angular-ui-router": "0.2.13",
|
||||
"angular-ui-select2": "angular-ui/ui-select2#afa6589a54cb72815f",
|
||||
"angular-ui-utils": "0.1.0",
|
||||
"bootstrap": "3.1.0",
|
||||
"bootstrap-growl": "ifightcrime/bootstrap-growl#162daa41cd1155f",
|
||||
"bootstrap-tour": "0.10.1",
|
||||
"css-social-buttons": "samcollins/css-social-buttons#v1.1.1 ",
|
||||
"github-buttons": "mdo/github-buttons#v3.0.0",
|
||||
"hello": "1.5.0",
|
||||
"jquery": "2.1.0",
|
||||
"jquery-colorbox": "1.4.36",
|
||||
"jquery-ui": "1.10.3",
|
||||
"jquery.cookie": "1.4.0",
|
||||
"js-emoji": "snicker/js-emoji#f25d8a303f",
|
||||
"marked": "0.2.9",
|
||||
"ngInfiniteScroll": "1.0.0",
|
||||
"jquery-colorbox": "~1.4.36",
|
||||
"pnotify": "~1.3.1",
|
||||
"jquery-ui": "~1.10.3",
|
||||
"hello": "~1.5.0",
|
||||
"css-social-buttons": "https://github.com/samcollins/css-social-buttons.git#4c045e5",
|
||||
"angular-filter": "~0.5.1",
|
||||
"angular-ui-router": "~0.2.13"
|
||||
"pnotify": "1.3.1",
|
||||
"sticky": "*",
|
||||
"swagger-ui": "wordnik/swagger-ui#v2.0.24"
|
||||
},
|
||||
"devDependencies": {
|
||||
"angular-mocks": "1.3.9"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Common
|
||||
|
||||
Shared resources useful for the multiple HabitRPG repositories, that way all the repositories remain in-sync with common characteristics. Includes things like:
|
||||
Shared resources useful for the multiple Habitica repositories, that way all the repositories remain in-sync with common characteristics. Includes things like:
|
||||
|
||||
* Assets - sprites, images, etc
|
||||
* CSS - especially, esp. sprite-sheet mapping
|
||||
|
||||
@@ -2,12 +2,12 @@
|
||||
margin-left: 1.25em;
|
||||
}*/
|
||||
|
||||
/* Comment out for holiday events
|
||||
/* Comment out for holiday events */
|
||||
.npc_ian {
|
||||
background: url("/common/img/sprites/npc_ian.gif") no-repeat;
|
||||
width: 78px;
|
||||
height: 135px;
|
||||
} */
|
||||
}
|
||||
|
||||
.Gems {
|
||||
display:inline-block;
|
||||
|
||||
2
common/dist/sprites/habitrpg-shared.css
vendored
1630
common/dist/sprites/spritesmith0.css
vendored
BIN
common/dist/sprites/spritesmith0.png
vendored
|
Before Width: | Height: | Size: 219 KiB After Width: | Height: | Size: 250 KiB |
6136
common/dist/sprites/spritesmith1.css
vendored
BIN
common/dist/sprites/spritesmith1.png
vendored
|
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 25 KiB |
5526
common/dist/sprites/spritesmith2.css
vendored
BIN
common/dist/sprites/spritesmith2.png
vendored
|
Before Width: | Height: | Size: 101 KiB After Width: | Height: | Size: 112 KiB |
3076
common/dist/sprites/spritesmith3.css
vendored
BIN
common/dist/sprites/spritesmith3.png
vendored
|
Before Width: | Height: | Size: 89 KiB After Width: | Height: | Size: 93 KiB |
1396
common/dist/sprites/spritesmith4.css
vendored
BIN
common/dist/sprites/spritesmith4.png
vendored
|
Before Width: | Height: | Size: 502 KiB After Width: | Height: | Size: 598 KiB |
1284
common/dist/sprites/spritesmith5.css
vendored
BIN
common/dist/sprites/spritesmith5.png
vendored
|
Before Width: | Height: | Size: 226 KiB After Width: | Height: | Size: 245 KiB |
1784
common/dist/sprites/spritesmith6.css
vendored
BIN
common/dist/sprites/spritesmith6.png
vendored
|
Before Width: | Height: | Size: 195 KiB After Width: | Height: | Size: 206 KiB |
|
After Width: | Height: | Size: 3.3 KiB |
|
After Width: | Height: | Size: 3.2 KiB |
|
After Width: | Height: | Size: 3.4 KiB |
BIN
common/img/sprites/spritesmith/backgrounds/background_market.png
Normal file
|
After Width: | Height: | Size: 27 KiB |
|
After Width: | Height: | Size: 10 KiB |
BIN
common/img/sprites/spritesmith/backgrounds/background_stable.png
Normal file
|
After Width: | Height: | Size: 24 KiB |
|
After Width: | Height: | Size: 6.5 KiB |
BIN
common/img/sprites/spritesmith/backgrounds/background_tavern.png
Normal file
|
After Width: | Height: | Size: 6.0 KiB |
|
After Width: | Height: | Size: 25 KiB |
|
After Width: | Height: | Size: 3.1 KiB |
|
After Width: | Height: | Size: 1.5 KiB |
|
After Width: | Height: | Size: 3.1 KiB |
|
After Width: | Height: | Size: 1.5 KiB |
|
After Width: | Height: | Size: 3.2 KiB |
|
After Width: | Height: | Size: 3.1 KiB |
|
After Width: | Height: | Size: 3.0 KiB |
|
After Width: | Height: | Size: 3.3 KiB |
|
After Width: | Height: | Size: 3.0 KiB |
|
After Width: | Height: | Size: 3.2 KiB |
|
After Width: | Height: | Size: 445 B |
|
After Width: | Height: | Size: 3.1 KiB |
|
After Width: | Height: | Size: 3.0 KiB |
|
After Width: | Height: | Size: 3.1 KiB |
|
After Width: | Height: | Size: 3.0 KiB |
|
After Width: | Height: | Size: 3.1 KiB |
|
After Width: | Height: | Size: 3.1 KiB |
|
After Width: | Height: | Size: 3.0 KiB |
|
After Width: | Height: | Size: 2.9 KiB |
|
After Width: | Height: | Size: 3.2 KiB |
|
After Width: | Height: | Size: 2.9 KiB |
|
After Width: | Height: | Size: 3.0 KiB |
|
After Width: | Height: | Size: 3.0 KiB |
|
After Width: | Height: | Size: 3.0 KiB |
|
After Width: | Height: | Size: 3.0 KiB |
|
After Width: | Height: | Size: 3.0 KiB |
|
After Width: | Height: | Size: 2.9 KiB |
|
After Width: | Height: | Size: 3.1 KiB |
|
After Width: | Height: | Size: 3.1 KiB |
|
After Width: | Height: | Size: 1.5 KiB |
|
After Width: | Height: | Size: 3.1 KiB |
|
After Width: | Height: | Size: 1.6 KiB |
|
After Width: | Height: | Size: 3.1 KiB |
|
After Width: | Height: | Size: 1.4 KiB |
|
After Width: | Height: | Size: 18 KiB |
|
After Width: | Height: | Size: 3.4 KiB |
|
After Width: | Height: | Size: 3.4 KiB |
|
After Width: | Height: | Size: 3.2 KiB |
|
After Width: | Height: | Size: 3.3 KiB |
|
After Width: | Height: | Size: 3.1 KiB |
|
After Width: | Height: | Size: 2.9 KiB |
|
After Width: | Height: | Size: 2.9 KiB |
|
After Width: | Height: | Size: 2.9 KiB |
|
After Width: | Height: | Size: 3.3 KiB |
|
After Width: | Height: | Size: 3.3 KiB |
|
After Width: | Height: | Size: 3.1 KiB |
|
After Width: | Height: | Size: 3.2 KiB |
|
After Width: | Height: | Size: 3.3 KiB |
|
After Width: | Height: | Size: 3.1 KiB |
|
After Width: | Height: | Size: 3.0 KiB |
|
After Width: | Height: | Size: 3.0 KiB |
|
After Width: | Height: | Size: 2.9 KiB |
|
After Width: | Height: | Size: 3.1 KiB |
|
After Width: | Height: | Size: 696 B |
|
After Width: | Height: | Size: 3.0 KiB |
|
After Width: | Height: | Size: 3.0 KiB |
BIN
common/img/sprites/spritesmith/misc/knockout.png
Normal file
|
After Width: | Height: | Size: 2.8 KiB |
|
Before Width: | Height: | Size: 1.5 KiB After Width: | Height: | Size: 3.2 KiB |
BIN
common/img/sprites/spritesmith/misc/welcome_basic_avatars.png
Normal file
|
After Width: | Height: | Size: 10 KiB |
BIN
common/img/sprites/spritesmith/misc/welcome_promo_party.png
Normal file
|
After Width: | Height: | Size: 16 KiB |
BIN
common/img/sprites/spritesmith/misc/welcome_sample_tasks.png
Normal file
|
After Width: | Height: | Size: 5.4 KiB |
|
Before Width: | Height: | Size: 5.9 KiB After Width: | Height: | Size: 4.8 KiB |
|
Before Width: | Height: | Size: 3.8 KiB After Width: | Height: | Size: 3.6 KiB |
|
Before Width: | Height: | Size: 5.0 KiB After Width: | Height: | Size: 5.0 KiB |