Skip to content

Commit

Permalink
Editing markdown files and adding the favicon to the index page.
Browse files Browse the repository at this point in the history
  • Loading branch information
agitperson committed Jan 2, 2018
1 parent f48ff6e commit 84c7e3c
Show file tree
Hide file tree
Showing 4 changed files with 143 additions and 14 deletions.
63 changes: 63 additions & 0 deletions CODE_OF_CONDUCT.md
@@ -0,0 +1,63 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting Dan on [Twitter](https://twitter.com/danjasnowski). All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
45 changes: 45 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,45 @@
# Contributing

We love pull requests from everyone. By participating in this project, you agree to abide by the project's [code of conduct].

[code of conduct]: https://github.com/Navarra/game/blob/master/CODE_OF_CONDUCT.md

Fork, then clone the repo:

git clone git@github.com:your-username/game.git

Install the dependencies:

npm install / yarn

Start the development server:

npm run dev

Push to your fork and [submit a pull request][pr].

[pr]: https://github.com/Navarra/game/compare/

At this point you're waiting on us. We like to at least comment on pull requests within three business days (and, typically, one business day). We may suggest some changes or improvements or alternatives.

Some things that will increase the chance that your pull request is accepted:

* Write tests.
* Follow our [style guide][style].
* Write a [good commit message][commit].

[style]: https://github.com/airbnb/javascript
[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

## Code conventions

We have ESLint to check for style in the JavaScript and .vue files. Before you commit, please run a check and auto-fix before submitting a pull-request.

We use [AirBnB's JavaScript guide](https://github.com/airbnb/javascript) to keep the codebase all in one cohesive format. Having an editor like Microsoft's [VS Code](https://code.visualstudio.com/) will help check for ESLint mistakes as you write code. It is highly recommended.

### Contribution Tools
We are in the process of adding these tools to help make the process of contributing and in general easier in the future.

- Sass Style checking (CSS)
- Commit checks. Check for style issues before commiting.
- Unit tests within Vue components
29 changes: 23 additions & 6 deletions README.md
Expand Up @@ -8,24 +8,41 @@ Welcome to Navarra. A 2D top-down medieval fantasy game using Vue.js, the latest

$ git clone https://github.com/Navarra/game
$ cd game
$ npm install / yarn
$ npm install (or) yarn
$ npm run dev

Visit http://localhost:8080, or whichever it tells unless you are using port 8080 for something else.
Visit http://localhost:8080, or whichever it tells unless you are using port 8080 for something else. You're all set!

## Contributing

Please check out our [CONTRIBUTING.md](https://github.com/Navarra/game/blob/master/CONTRIBUTING.md) guide on how you can actively participate in the development of this medieval game. It's pretty easy!

## Systems and Engines

Here are the types of things I will be adding. Not too over the top but enough to cover the basics until more is added.
Here are the types of things I will be adding. Not too over the top but enough to cover the basics until more is added. Each section links to a project which will contain its sub-tasks within.

- Player
- [Player](https://github.com/Navarra/game/projects/1)
- Walking / pathfinding
- Statistics (D3 / data-viz)
- Inventory
- Character wear
- NPC
- [User Interface](https://github.com/Navarra/game/projects/2)
- Inventory
- Character wear
- Overall look & feel
- Basic view of main player stats
- [NPC](https://github.com/Navarra/game/projects/3)
- Trading
- Interaction
- Monsters
- [Monsters](https://github.com/Navarra/game/projects/3)
- Battling
- Pickups / Loot
- Spawning

## Notice

Navarra contains work from multiple sources not organically made by contributions from Navarra directly.

- [Tileset, monsters, items, players](http://pousse.rapiere.free.fr/tome/tome-tiles.htm) by David E. Gervais. · [CC license](https://creativecommons.org/licenses/by/3.0/)

- [Main screen music](https://opengameart.org/content/enchanted-festival) by [Matthew Pablo](http://www.matthewpablo.com). · [CC license](https://creativecommons.org/licenses/by/3.0/)
20 changes: 12 additions & 8 deletions index.html
@@ -1,11 +1,15 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1.0">
<title>navarra &middot; medieval 2d rpg</title>
</head>
<body>
<div id="navarra"></div>
</body>

<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1.0">
<title>Playing Navarra &middot; fun medieval game</title>
<link rel="shortcut icon" href="src/assets/sword-icon.png" type="image/png">
</head>

<body>
<div id="navarra"></div>
</body>

</html>

0 comments on commit 84c7e3c

Please sign in to comment.