RSamaium / RPG-JS

Framework to create an RPG or MMORPG (with the same code) in the browser with Typescript
https://rpgjs.dev
MIT License
1.35k stars 205 forks source link

Full documentation in english #4

Closed DanielRuf closed 12 years ago

DanielRuf commented 13 years ago

Im missing the full english documentation (i cant understand french so good) and also what file types are supported eg for the background music (mp3, ogg, ... maybe using soundmanager 2 or modernizr, and also have the same audio file with different file extensions like bg.mp3 bg.ogg, and the one is selected that the browser supports?)

and also a demo project (yours?) so we can see how the structure has to be and where to put what

makes it all easier and also committing and testing =)

RSamaium commented 13 years ago

This documentation is here: http://rpgjs.com/doc You can download the demo here: http://rpgjs.com/examples/demo.php

To load a music background, you can:

rpg.loadMap('Map', { tileset: 'mytileset.png', bgm: {mp3: 'Music', ogg: 'Music'} });

Musics "Music.mp3" and "Music.ogg" must be in the dir "Audio/BGM"

DanielRuf commented 13 years ago

well, most of the documentation isnt in english, am i right?

and the strcuture described in the doc - would be great if you would iclude it with the demo project in the git so we dont have to create it manually

RSamaium commented 13 years ago

it is in English, right ? Where do you see any other language in the documentation? :/

DanielRuf commented 13 years ago

i mean the wiki, that is for me a documentation tried the demo, it doesnt work here on my local machine

RSamaium commented 13 years ago

Indeed, the wiki is not English. Maybe someone wants to translate it in English?

For the demo, it must be run on a server "http://localhost" in local

DanielRuf commented 13 years ago

i had for some years french in school, but this was many years ago

arpunk commented 13 years ago

@KAOSFORGE the demo works, you just gotta serve it in http://localhost. The API is also documented and if you need (right now) more documentation you can start looking at RPG Maker XP.

@RSamaium I can help out with documentation while I gasp the whole structure of the project but I don't know french. Once you release the beta we can start working on the wiki? How is the beta comming? :)

DanielRuf commented 13 years ago

i meant the wiki, in full english instead of french =) i know t wih the localhost, but it would be great if it would work also without that

arpunk commented 13 years ago

@KAOSFORGE If I recall correctly, RPGJS makes AJAX calls for loading the different images and sounds, thats why it cannot work without a webserver.

We can start writting the wiki in english, it's not that hard once you get the articles translated in google translate and then writting them in top of the translation, thats how I've been doing for the wiki.

We can also start writting in the github wikis if @RSamaium enables them :P

RSamaium commented 13 years ago

@KAOSFORGE Thank you for the translation.

" How is the beta comming? :)"

I do not know yet ;)

DanielRuf commented 13 years ago

yes, working on github with the wiki would be great =) I will maybe,l if there is the wiki here on github, fork it and translate it to german and help with the english translation

arpunk commented 13 years ago

@KAOSFORGE Now there is. I tried to translate some of the wiki pages but they still need a lot of love.

DanielRuf commented 13 years ago

I will try my best =) 4 years pf school french should be enough? ^^