Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add tmw-branded help #230

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions help/about-server.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<- @@index|<<Back to Index>>@@


##3 === <<ABOUT THE MANA WORLD>> ===

##2<<The Mana World##0 is a serious effort to create an innovative free
and open source MMORPG world. The Mana World uses 2D graphics and aims to be
as much diverse and interactive as possible. All content is licensed
under the GPL, making sure this game can't ever run away from you.>>

-> @@http://themanaworld.org/|http://themanaworld.org/@@
11 changes: 11 additions & 0 deletions help/about-tmw.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<- @@index|<<Back to Index>>@@


##3 === <<ABOUT THE MANA WORLD>> ===

##2<<The Mana World##0 is a serious effort to create an innovative free
and open source MMORPG world. The Mana World uses 2D graphics and aims to be
as much diverse and interactive as possible. All content is licensed
under the GPL, making sure this game can't ever run away from you.>>

-> @@http://themanaworld.org/|http://themanaworld.org/@@
Empty file added help/footer.txt
Empty file.
123 changes: 123 additions & 0 deletions help/gmcommands.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
<- @@index|<<Back to Index>>@@
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a note to the effect "this is a static copy of the list and may be outdated, see @help for what this server actually supports".

Also mention the other forms of @help

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, instead of filling the bulk of these out by hand, generate them from tmwa itself, it already has a --write-atcommand-file setting.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@o11c the @help command either does not send all commands or manaplus truncates the message; I had to ask wushin for a copy of atcommand_local



##3 <<GM commands>>


##9<<0: normal players>>
##2
<<@help all - displays the gm level required for gm commands.>>
<<@servertime - displays the server time.>>
<<@source - displays the version number, last commit and the github repo url.>>
<<@wgm <message> - send a message to all connected GMs.>>
<<@email <email> - changes the e-mail address associated with your account.>>

##9<<40: developers>>
##2
<<@hairstyle <style-id> - changes your hairstyle.>>
<<@haircolor <color-id> - changes your hair color.>>
<<@itemreset - deletes all of your items.>>
<<@broadcast <message> - sends a global announcement on all maps.>>
<<@localbroadcast <message> - sends a global announcement on the map you are on.>>
<<@die - kills your character.>>
<<@goto <player> - warps yourself to the specified player.>>
<<@charstats <player> - show a bunch of stats about a single user.>>
<<@heal [hp] [sp] - restore or destroy your health.>>
<<@return, @load - return to your respawn point.>>
<<@save - set your respawn point to your current location.>>
<<@sp-info <player> - displays level of "focus" skills.>>
<<@t <message>, @tee <message> - write a message to the log and public chat.>>
<<@l <messate>, @log <message> - write a message to the log.>>
<<@warp <map> [x] [y] - warp to the specified map.>>
<<@jump [x] [y] - warp to another location on the same map.>>
<<@where [player] - displays the location of the specified player or yourself.>>
<<@who [subsequence] - list matching players online, with location info.>>
<<@whogm [subsequence] - list matching GM players, with location, level, and party info.>>
<<@whogroup [subsequence] - list matching players online, with party info.>>
<<@whomap [map] - list all players on the map, with location info.>>
<<@whomapgroup [map] - list all players on the map, with party info.>>
<<@hide - makes you invisible to monsters and unable to attack.>>

##9<<50: event coordinators>>
##2
<<@spawn <mob> [amount] [x] [y] - spawn normal monsters at location.>>
<<@summon <mob> - summon a slave monster temporarily.>>
<<@invisible - makes you invisible to players with a GM level below your GM level.>>
<<@visible - makes you visible to all players.>>

##9<<60: game masters>>
##2
<<@charstatsall - show stats of all characters online.>>
<<@pvpon, @pvpoff - enable or disable pvp on the map you are on.>>
<<@speed <rate> - sets the speed at which you walk/attack, default is 150.>>
<<@killmonster [map] - kills all monsters on the map.>>
<<@killmonster2 [map] - kills all monsters on the map without drops.>>
<<@gat - dump the local walkmap.>>
<<@ipcheck <player> - list online players on the same IP address.>>
<<@storeall - stores all of your items.>>
<<@killable - allows other players to kill you, resets when you equip/unequip.>>
<<@killer - allows you to kill anyone, resets when you equip/unequip.>>
<<@charkillable <player> - makes another player killable.>>
<<@charkiller <player> - makes another player able to kill anyone.>>
<<@alive - resurrects yourself, at 100% hp and mp.>>
<<@blvl <delta> - raises or decreases your level.>>
<<@jlvl <delta> - raises or decreases your job level.>>
<<@charbaselvl <delta> <player> - raises or decreased the level of another player.>>
<<@charjlvl <delta> <player> - raises or decreased the job level of another player.>>
<<@charchangesex <player> - changes the sex of another player.>>
<<@charstpoint <amount> <player> - adjust the stat points or another player.>>
<<@charskpoint <amount> <player> - adjust the skill points or another player.>>
<<@charreset <player> - reset the stats of another player.>>
<<@charwipe <player> - resets a character back to when it was first created.>>
<<@charsave <map> <x> <y> <player> - saves the respawn point of another player.>>
<<@kill <player> - kills another player.>>
<<@recall <player> - warps another player to you.>>
<<@revive <player> - revive another player.>>
<<@charwarp <map> <x> <y> <player> - warps another player to another map.>>
<<@str <delta> - changes status of your character.>>
<<@agi <delta> - changes status of your character.>>
<<@dex <delta> - changes status of your character.>>
<<@vit <delta> - changes status of your character.>>
<<@int <delta> - changes status of your character.>>
<<@lux <delta> - changes status of your character.>>
<<@allstats [value] - adjust all stats to value (or maximum).>>
<<@stpoint <amount> - increase your stat points.>>
<<@skpoint <amount> - increase your skill points.>>
<<@kick <player> - kick another player from the server.>>
<<@block <player> - permaban another player.>>
<<@unblock <player> - unban another player.>>
<<@ban <time> <player> - ban another player for a limited time.>>
<<@unban <time> <player> - reduced or removed the ban.>>
<<@chardropall <player> - force a player to drop all of their items.>>
<<@charstoreall <player> - force a player to store all of their items.>>
<<@hugo, @linus - iterate over players forward or backward.>>

##9<<80: greater dev>>
##2
<<@setmagic <school> <value> <player> - set magic properties of another player.>>
<<@magicinfo <player> - get magic properties of another player.>>
<<@option <opt1> [opt2] [option] - set your 'option' status flags.>>
<<@ - .>>
<<@ - .>>
<<@ - .>>
<<@ - .>>
<<@ - .>>
<<@ - .>>
<<@ - .>>
<<@ - .>>
<<@ - .>>
<<@ - .>>
<<@ - .>>
<<@ - .>>
<<@ - .>>
<<@ - .>>
<<@ - .>>
<<@ - .>>
<<@ - .>>
<<@ - .>>
<<@ - .>>
<<@ - .>>
(got bored, will add the rest of the commands tomorrow)


<- @@index|<<Back to Index>>@@
Empty file added help/header.txt
Empty file.
15 changes: 15 additions & 0 deletions help/index.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@

<<##2ManaPlus version: ##6%VER%>>

##3 === <<INDEX>> ===

##1-> @@about|<<About>>@@
-> @@download|<<Download>>@@

-> @@commands|<<Keyboard Commands>>@@
-> @@chatcommands|<<Chat commands>>@@
-> @@gmcommands|<<GM commands>>@@
-> @@windows|<<Windows>>@@
-> @@skills|<<Skills>>@@

-> @@support|<<Support>>@@
21 changes: 21 additions & 0 deletions help/skills.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<- @@index|<<Back to Index>>@@


##3 === <<SKILLS>> ===

<< You can improve your skills by increasing job level. Each job level
gives you 1 point to spend on basic skills.>>

##4 <<Basic skills:>>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't use these anymore, right?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we do not but cassy made them "alwaysVisible" in skills.xml so I kept them here as well

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, please. People become confused when those skills aren't visible.


<<##2Emote:##9 enables the ability to express emotions.>>
<<##2Trade:##9 enables the ability to trade with others.>>
<<##2Party:##9 enables a player to create or join a party.>>

##4 <<Magic skills:>>

<<##9Magic skills can be obtain by doing quests and missions in game.>>

##4 <<Focus skills:>>

<<##9Focus skills can be obtain by doing quests and missions in game.>>
16 changes: 16 additions & 0 deletions help/support.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<- @@index|<<Back to Index>>@@


##3 === <<SUPPORT>> ===

<<For TMW support:>>

##2 @@http://forums.themanaworld.org/viewforum.php?f=3|http://forums.themanaworld.org@@
<<or come visit us on our IRC channel:>>
##2 #themanaworld ##9@##2 irc.freenode.net



##3<<For ManaPlus support:>>

##2 @@http://manaplus.org/#contacts|http://manaplus.org@@
17 changes: 17 additions & 0 deletions help/tags.idx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
about-mp|about
about-mp|about manaplus
about-mp|manaplus about
about-mp|manaplus
chatcommands|chat
chatcommands|commands
chatcommands|chat commands
chatcommands|chat command
gmcommands|gm
gmcommands|gm commands
gmcommands|gm command
skills|skills
index|index
tips/12|warp
tips/12|warps
tips/16|download
tips/16|downloads
3 changes: 3 additions & 0 deletions help/tips/1.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<<You can hide/show bars and buttons by right click and select menu item.>>
~~~help/tips/1-1.jpg~
~~~help/tips/1-2.jpg~
2 changes: 2 additions & 0 deletions help/tips/10.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<<If client working very slow, you can improve speed
by reading this: @@http://manaplus.org/slowpc|http://manaplus.org/slowpc@@>>
2 changes: 2 additions & 0 deletions help/tips/11.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<<You can imitate other players by selecting "imitation" in player context menu
or type chat command: /imitate playername.>>
3 changes: 3 additions & 0 deletions help/tips/12.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<<You can walk to warps automatically.
Open Social Window (###keyWindowSocial;) and selecy Nav tab,
then click on warp what you want.>>
2 changes: 2 additions & 0 deletions help/tips/13.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<<You can use mumble voice chat for talking with other players.
Start mumble before client start and enable mumble in settings.>>
1 change: 1 addition & 0 deletions help/tips/14.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<<You can change any key in keyboard settings.>>
2 changes: 2 additions & 0 deletions help/tips/15.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<<You can do basic searching in help by using command
##2?text>>
3 changes: 3 additions & 0 deletions help/tips/16.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<<Look this page for help and downloads:>>

@@http://manaplus.org/|http://manaplus.org/@@
1 change: 1 addition & 0 deletions help/tips/17.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<<To type chat message, press ###keyChat;>>
3 changes: 3 additions & 0 deletions help/tips/18.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<<You can select other themes.
For this you should open settings and select theme tab
and change "gui theme">>
2 changes: 2 additions & 0 deletions help/tips/2.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<<You can buy or sell items from players shops.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can these be named 02.txt for proper sorting?

Also splitting these into a separate commit in the same PR would be nice.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no, they can not be 0X because manaplus does loadData(num + 1); and loadData(num - 1);

yes, I will put the tips in a separate commit

Right click on player and select "Buy" or "Sell">>
2 changes: 2 additions & 0 deletions help/tips/3.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<<You can disable yellow bar,
by pressing ###keyDisableGameModifiers;.>>
2 changes: 2 additions & 0 deletions help/tips/4.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<<You can restore yellow bar settings,
by right click on it and select in context menu "Reset yellow bar".>>
2 changes: 2 additions & 0 deletions help/tips/5.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<<You can copy value from any bar,
by right click on it and select in context menu "Copy to chat".>>
2 changes: 2 additions & 0 deletions help/tips/6.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<<You can set away mode,
by type in chat command /away>>
2 changes: 2 additions & 0 deletions help/tips/7.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<<You can see other player equiped items,
by right click on player and select in context menu "Show Items".>>
2 changes: 2 additions & 0 deletions help/tips/8.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<<About yellow bar you can read here:
@@http://manaplus.org/yellowbar|http://manaplus.org/yellowbar@@>>
3 changes: 3 additions & 0 deletions help/tips/9.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<<You can set any client resolution. In settings in video tab,
click on "custom" and enter for example: 900x500 and press ok.>>