summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorjak1 <mike.wollmann@gmail.com>2021-07-20 21:44:22 +0200
committerjak1 <mike.wollmann@gmail.com>2021-07-20 21:44:22 +0200
commit83cf72b77de5c62f7a355766165d68e513eaaf2e (patch)
tree46bb1f5471d646ea309be905976043cff0235269 /docs
downloadthepixelworld-83cf72b77de5c62f7a355766165d68e513eaaf2e.tar.gz
thepixelworld-83cf72b77de5c62f7a355766165d68e513eaaf2e.tar.bz2
thepixelworld-83cf72b77de5c62f7a355766165d68e513eaaf2e.tar.xz
thepixelworld-83cf72b77de5c62f7a355766165d68e513eaaf2e.zip
init game repo (basic)
Diffstat (limited to 'docs')
-rw-r--r--docs/Command proto model.md93
-rw-r--r--docs/Database proto model.md51
-rw-r--r--docs/FAQ.md3
-rw-r--r--docs/UI proto model.md6
4 files changed, 153 insertions, 0 deletions
diff --git a/docs/Command proto model.md b/docs/Command proto model.md
new file mode 100644
index 0000000..06f7498
--- /dev/null
+++ b/docs/Command proto model.md
@@ -0,0 +1,93 @@
+commands:
+
+ user ( / ):
+ player (default):
+ /who
+ /help
+ /afk
+ /back
+ /where
+ /yes /no
+ /version
+ /git
+ /gm [message]
+ /exit
+ /setmail
+
+ helper ((requestable) adds a ?):
+ /help <username> <helppage> (opens the help page for the given player)
+
+ supporter ((buyable (once 9.99)) adds a lightblue vip):
+ /ninja (makes the player invisible for 1 min. (usable once every 20min))
+
+ supporter+ ((buyable (9.99/months)) adds a darkblue vip):
+ /ninja (makes the player invisible for 1 min. (usable once every 10min))
+ /tpa <username> (requires /yes from the player)
+
+
+ guild ( # ):
+ #motd <msg>
+ #create <guildname> (quest/npc only?)
+ #exp <1/0,on/off,enable/disable>
+ #items <1/0,on/off,enable/disable>
+ #hall (goto guildhall)
+ #gvg <1/0,on/off,enable/disable>
+ #settings
+ #invite <playername>
+
+ party ( . ):
+ .create <partyname>
+ .exp [1/0,on/off,enable/disable]
+ .items [1/0,on/off,enable/disable]
+ .settings
+
+ staff ( @ ):
+ gm (adds GM):
+ @where [username]
+ @who
+ @whomap [mapname]
+ @goto <username>
+ @recall <username>
+ @linus/@hugo/@back
+ @[un]block <username> [reason]
+ @[un]ban <username> [<time> [reason]]
+ @kick <username> [reason]
+ @spawn <mob-name/id> [quantity] [name] [stats] [callfunc]
+ @summon <mob-name/id> [quantity] [name] [stats] [callfunc]
+ @[set]home [id]
+ @[in]visible
+ @usergroup <username> [player/helper/supporter/supporter+]
+ @stfu [time (if not set infinite, or till the gm leaves the map)]
+ @mute <playername> <time>
+ @npc <npcname>
+ @exp <100-250> (rate in %)
+
+ dev (adds wrench):
+ @debug <param[s]>
+ @weather <rain/fog/snow/sun/clear>
+ @season <spring/summer/autumn/winter>
+ @time <0100/day(08:00)/night(20:00)>
+ @[un]hide
+ @bc <message>
+ @lbc <message>
+ @l <message>
+ @t <message>
+ @disablenpc <npcname>
+ @enablenpc <npcname>
+ @getguildid <guildname>
+ @getpartyid <partyname>
+
+ admin (adds red star):
+ @lvl <+-value>
+ @kickall
+ @restart [time]
+ @shutdown [time]
+ @recallall
+ @recallparty <partyname>
+ @recallpleader <partyname>
+ @recallguild <guildyname>
+ @recallgleader <guildyname>
+ @setstate <queststate> <value> [playername]
+ @getstate <queststate> [playername]
+ @item <itemID/Name> [quantity] [stats] [callfunc]
+ @save
diff --git a/docs/Database proto model.md b/docs/Database proto model.md
new file mode 100644
index 0000000..b9c8c00
--- /dev/null
+++ b/docs/Database proto model.md
@@ -0,0 +1,51 @@
+Database:
+
+ Entity(
+ ID,
+ Name,
+ pos(x, y, z-order, map, sit(0/1)),
+ equipment([slot, itemID]),
+ flags([muted, banned, blocked, canMove]),
+ );
+
+ DB:Monster(
+ Entity(),
+ behavior(active, passive, shy),
+ exp(),
+ items([]),
+ questflags(),
+ );
+
+ DB:players(
+ Entity,
+ username,
+ password,
+ email,
+ group(usergroup, staffgroup),
+ inventory([itemID, quantity]),
+ storage([itemID, quantity]),
+ money(char, bank)
+ states(questID or Name, value),
+ homes([homeID,[x,y,map]])
+ guild(guildID),
+ party(partyID),
+ ...
+ );
+
+ DB:guilds(
+ guildID,
+ guildname,
+ storage([itemID, quantity]),
+ money(bank),
+ player([id, grade, userflags]),
+ states(guildQuestID or Name, value),
+ guildflags(exp, item),
+ );
+
+ DB:partys(
+ partyID,
+ partyname,
+ player([id, grade]),
+ partyflags(exp, item),
+ );
+
diff --git a/docs/FAQ.md b/docs/FAQ.md
new file mode 100644
index 0000000..1837a09
--- /dev/null
+++ b/docs/FAQ.md
@@ -0,0 +1,3 @@
+## nothing to see here...
+## may there are questions that dont get asked frequently enough? ^^
+## in case you have any questions, just ask \ No newline at end of file
diff --git a/docs/UI proto model.md b/docs/UI proto model.md
new file mode 100644
index 0000000..8f023f8
--- /dev/null
+++ b/docs/UI proto model.md
@@ -0,0 +1,6 @@
+stats:
+ fame int
+ lvl int
+ hp bar(int / int)
+ mp bar(int / int)
+ rank String (newbie, hunter, hero, legend, god) \ No newline at end of file