Hymené

Administrators Document

By Chalcedony

Rev 1.31

 

 

This document will explain all the commands for Hymené administrators and helpers. Firstly, I must explain how the system works. The Hymené world is run on a main server. This server is the hub for all communication. Clients or Players connect to the server, using UDP protocol. However, it doesn't end there. An additional port on the server connects TCP to an IRC server, into what is known as the Spirit Realm.

 

 

 

This means, our world is as follows:

 

                               _______

 -----------                  /       \       /-----Client(Bob)

|           |                /   HUB   \     |

|   IRC     |=====TCP========:  (MAIN  :=UDP==----Client(Paul)

|  SPIRIT   |                \ SERVER) /     |

|   REALM   |                 \_______/       \----Client(and so on...)

|           |                 

 -----------

 

 

There are many types of admins with different powers, with access to different commands. First I will explain the PLAYER admins, and the Player Levels. Each player may log into the server with a username and password on the servers Player Database. This will allow them to gain an official server-side level of 1-8.

 

 

Player Levels

      1      Player

      2      Hero

      3      Nephilim

      4      Angel

      5      Arcangel

      6      God-Six

      7      God-Seven

      8      God-Eight

      9      Secret Service

      0      Damned

 

 

Player

Level one gives you the rights of a normal player. This means no god and angel commands - you are a regular.

 

Hero

Heroes don't really have any more rights than a player (possibly a few things), but they are generally more trusted do-gooders. They are given level 2 hero status to indicate they are extra VIP players, who know more than regulars.

 

Nephilim

This is an angel in training, or a child to an angel. They have a few more commands but not enough to be an angel. They will follow an angel around and learn the ways.

 

Angel

These are players who dedicate thier playing time to helping others by using special powers and shortcuts to make other players gaming more comfortable.

 

Arcangel

Another higher form of angel - the job is the same but the powers are more great. Angels and arcangels spend much of thier time flying around and watching over people. You are more likely to see angels and arcangels than gods.

 

God-Six

The first stage of God. They have some of the God Commands. These are powerful commands that go through the server and allow more manipulation and information on the clients from the server side.

 

God-Seven

As the god-six but more powerful, with access to nearly all the commands. Gods can kill people and find out all sorts of information and do many tricks.

 

God-Eight

Finally, the God-Eight is the highest of the gods, able to alter server config completely, as if he were at the server console himself.

 

Secret Service

You will probably never see a level 9, but if you do, it is to regain power over some idiotic level 8 who decided to betray the network, lol. You cannot become secret service, only I can.

 

Damned

A level 0 person is considered damned. People are level 1 by default, so if you sign in as level 0 it might mean you are in trouble - or a vampire or something. More on that another time I think.

 

 

 

Creating and becoming player admins

 

Only a player or spirit with a greater level than you, and with a level of 4+ can add you as an admin. Admins can only add someone who is lower than themself. This keeps a lot more order than if they could just add people with the same power. This way no-one is overthrown by thier maker.

 

 

 

Player Admin Commands

 

I will now write out the different player admin commands that you can do inside the Hymené client, with the level required to perform them.

 

 

Level 1+

/pray [message]

This command can be done by normal clients too. They can /pray and all 4+ angels will hear it. Angels can talk to each other through prayer too. In the spirit realm, spirits will see the prayer, and a special channel for prayers will recieve it too. This means if spirits arent paying attention in one channel, they will see it in another. Use /pray if you are in trouble or need quick assistance from an angel or spirit.

 

Level 3+

/supercloak

This will supercloak you, with no device. This means people don't even see your name in the same room. /decloak will turn it off. Your STATE on the server side will be known as CLOAKED. This may mean you cannot do certain things like talk in the room etc.

 

Level 3+

/touch [name]

This will set focus on that client, so that you can do angelic gifts or commands. Type your own name to target yourself. Players can target people using magic, and it is the same thing. This way however, you can do it without magic. If you are level 3+ you will be told who you touched (obviously). The person will know they have been touched and recieve a message.

 

Using the /touch command is also a good way to prove that you are a genuine admin, since you must be at least level 3 to be able to do it. This is a good way of proving yourself.

 

Level 4+

/angel [command]

This will perform an angel command on your current target. These are the possible angel commands you can use:

 

/angel cloak

Cloak them (no device needed).

 

/angel supercloak

Supercloak them (no device needed).

 

/angel center

Center them to co-ordinate 0,0,0.

 

/angel save

Give them 100 health and make them alive again.

 

/angel life

Give them 100 health.

 

/angel denunter

Make them cured of nuntergobber addiction.

 

/angel Reveal

Make them wear light, hand of comets, 1000 health.

 

/angel kill

Make life -10. (will kill them usually)

 

/angel immune

Make them immune to angelic commands.

      Note: Don't use this unless it's an emergency.

      See the bottom note for this.

 

/angel sober

Sober them from drunkness and some of its effects.

 

/angel newcar

Make the car 500 hp.

 

/angel supercar

Make the car 2000 hp

 

/angel portal # [map]

Send someone to this location.

      NOTE: if you mess this up, you will probably

      disconnect them because of map-not-found.

 

/angel teleport [x] [y] [z]

Teleport the persons co-ordinates to these values. Y is upwards. Be careful lol. 0 0 0 will usually send them to the center of the map somewhere.

 

/angel hitch [taxiname]

Force them to hitch to this person

 

/angel unhitch

Force them to unhitch to all, regardless. If you type /angel hitch [unknownname] it will do the same.

 

/angel pollum

Cast effect of pollum, waking them up etc.

 

/angel help

100 life, bring back to life, spawn @ 0, and stop falling speed. Will lso make you exit your car. Hopefully will stop falling deaths, and take away overdose.

 

/angel defrendzy

This is a new one, will take away frendzy_drug, frendzygood and frendzybad - so hopefully all signs of frendzy, but not always the symptoms.

 

/angel console [command]

This command is funny, don't abuse it. It allows you to type at the persons console as if it were themselves. Good for helping out people to do lots of commands, or simply to pump them up with drugs.

NOTE: An angel can make themselves angelically immune. To make yourself non-immune type /immunity off

/immunity will show you your current immunity status.

Also, the command which is usually uppercase in an angel command, will be returned as lowercase, because all commands are lowercase.

 

/angel name [name]

/angel color1 [color1]

/angel color2 [color2]

/angel color3 [color3]

/angel MARKARIGAN

/angel WAHALECH

 

These will force config options, for dim people who don't know how to change a name.

 

 

 

Map Properties

 

indoors           indoors=1

 

outdoors          indoors=0, cars can be driven, and weather applies

 

holy              holy=1, no guns can be drawn

 

unholy            holy=0

 

 

 

Level 5+

/agive [item_char_code]

you can type /agift * and /angelic item * also.

This will give that item code (as long as you know it) to that client, even if you don't have it. There are some additional item codes for /agive too, such as MANA, CASH_10000, CASH_1000 etc.

 

Level 6+

/aspecial [code:itemname]

This will give the target a special item. The code must be 4 digits, with a : or space, and then the item name. Make sure the code matches the item name perfectly, or the item will be false, and you might be caught as a 'cheater' and sent to hell! lol!

 

      Example:      /aspecial 1234 Laser Sight

 

Level 3+

/tongue [message]

This command is to 'tongue'. You must be level 3+, and everyone of your level or higher will see the message.

 

Level 6+

/global [message]

Everyone regardless of who they are, on the entire server, will see this message.

 

Level 4+

/bounce [x] [y] [z]

Bounce to a additional co-ordinate compared to your current location.

NOTE: I have not programmed this, I might not ever code it actually because /teleport is better.

 

Level 5+

/teleport [x] [y] [z]

Relocate to this co-ordinate in general. Careful - it's very dangerous! The Y co-ordinate puts you higher up the higher it is.

 

Level 6+

/portal [spawn number] [map name]

The spawn number must be 0-9. Can't go above that.

The map name is the map name - if you mess up, you will disconnect from the server!

 

 

 

God Commands

 

For various levels.

 

 

Syntax:

/god [command]

These are commands that go straight to the server as all level commands do.  They vary depending on what level you are. The higher level you are the more commands you can do.

 

/god clients

(Level 3)

Ask how many clients out of how many clients are connected.

 

/god players

(Level 4)

Show a list of ALL online players, with thier map and state. Very useful for spirits (use .god players if you are a spirit).

 

/god admin heroes

(Level 2)

View names of level 2.

 

/god admin nephilim

(Level 2)

View names of level 3.

 

/god admin angels

(Level 1)

View names of level 4-5.

 

/god admin gods

(Level 4

View names of level 6-8.

 

/god admin all

(Level 4)

View names of level 4-8.

 

/god level stats

(Level 3)

View how many people of each level 0-10 there currently online, in numbers.

 

/god id [#]

(Level 5/6)

View server data of the client number. 6 means you see more, ip, port, etc.

 

/god data [#]

(Level 7)

View server data of clients, but all the data.

 

/god account [#]

(Level 4)

View bank and land data of that number, including money and passwords.

 

/god view worldcash

(Level 3)

View the worldcash money amount.

 

/god kill [#]

(Level 6)

Remove that client id off the server with message "Killed from server by a God."

 

/god oper list

(Level 3)      View the admin server account list (people of level 2+). You see all passwords of people lower than you.

 

/god client list

(Level 3)

View the admin server account list of clients (level 1 or less). Only passwords seen by L4+.

 

/god version [#]

(Level 2)

View this persons game version, by client ID. Only spirits can see this, because it outputs in the services IRC channel.

 

/god add oper [#] ******** [name]

(Level 4+)

Only a 4+ can add an oper, any level under thier level. Make sure the password is excactly 8 chars.

 

/god remove oper [name]

(Level 4+)

You are only able to remove someone below your level.

 

/god force car [str]

(Level 6)

Change PLAYER_CAR$ of your TARGET. This command is pretty much useless unless the client isn't currently sending updates.

 

/god force name [str]

(Level 7)

Change PLAYER_NAME$ of your target (The name of the client).

      NOTE: There maybe be lethal consequences, don't do this unless you really feel you have to.

 

/god force state [str]

(Level 6)

Change PLAYER_STATE$ of your TARGET. This could be changed to MAP_WAIT, or PLAY, etc. change this to PLAY to help someone who is stuck on map loading.

 

/god force mapwait [value]

(Level 6)

change PLAYER_MAPWAIT of your TARGET.

 

/god weather [timevalue]

(Level 7)

Sets the weather (day/night) (value 0-7200000)

NOTE: do /weather 1000000 to make it daytime again.

 

These following commands are immensely powerful and if you get it wrong you can crash clients and seriously mess things up.

 

/god lyn local [command]

(Level 5)

Send lyn command locally to a map.

 

/god lyn global [command]

(Level 6)

Send lyn command globally.

 

/god lyn invert [command]

(Level 6)

Send lyn command to global apart from you.

 

/god lyn private [command]

(Level 4)

Send lyn command to current target.

 

/god raw private [command]

(Level 6)

Send raw packet to target client.

 

/god raw local [command]

(Level 7)

Send raw packet to everyone in room including you.

 

/god raw invert [command]

(Level 7)

Raw to all clients but you.

 

/god raw global [command]

(Level 7)

Raw to global inclding yourself.

 

HACK NOTE:

if you send the lyn line INITGL then it will initgl and not call lyn. You will need to INITGL if you add cubes, panels, objects, etc (like a refresh screen).

 

 

 

Raw commands to server

Sending raw commands for the SERVER to interpret:

This is the most iffy of all raw commands. Hence, you have to use the client raw command to do it.

 

You send a raw command to yourself privately, with the client raw protocol, which bounces back to you, then resends itself to the server, checks for level 7, and is then interpretted as a raw packet.

 

      syntax: /god raw private pure PAC043918283etc....

 

For security, PURE: sends a PURE: line, not a raw line to the server. This is so that your level is checked as being level 7.

 

 

see server config...

                  level required

/god see server port

(Level 6)

 

/god see server name

(Level 6)

 

/god see server startmap

(Level 6)

 

/god see server rate

(Level 6)

 

/god see server timeout

(Level 6)

 

/god see server mapwait

(Level 6)

 

/god see server namelength

(Level 6)

 

/god see server maprate

(Level 6)

 

 

altering the server config...

 

/god set server port [number]

(Level 8)

The local port of the server. Altering this will mean people have to know where to connect to from now on.

 

/god set server name [name]

(Level 8)

Name of the server, or message you get when you connect to it.

 

/god set server startmap [mapname]

(Level 8)

Name of the map you start at. Make sure it exists!

 

/god set server rate [number]

(Level 8)

The rate the server spams PAC:Lines back. Lower means more packets and smoother animation, but more bandwidth.

 

/god set server timeout [number]

(Level 8)

How many seconds to wait until the server times out the client in playing status.

 

/god set server mapwait [number]

(Level 8)

The amount of seconds the player is timed out if he fails to recieve the map properly.

 

/god set server namelength [number]

(Level 8)

How many chars long can a nickname be?

 

/god set server maprate [number]

(Level 8)

The rate of which map packets are sent to the player (lyn code).

 

/god server restart

(Level 8)

Attempt to restart the server. This shouldnt be needed.

 

/god save server config

(Level 8)

Attempt to write the server config. Do this after making any of these changes.

 

 

 

NOTES

You will notice that you cannot add or remove opers lower than your level, and you cannot see passwords. You will also notice that you can't do this at level 8 either. A level 8 person cannot alter or add level 8 opers. This is for security and trust reasons. They must be added manually on the servers config.

 

You also can't add level 9's or more to the servers config. They are restricted to level 8. Only the secret service are able to login as level 9's.

 

 

 

Server Commands

 

Nextly we have the server itself. The console in the server allows you to do commands or talk to the Hymene world & Spirit Realm. To talk, simply type in the server console. To do a command, you will need a / and then the command.

 

/input [irc command]

This will input an IRC command (spirit command) directly from the server console itself. The system will think that it came from a person called 'server' from the channel 'server'. This means the response will come into the server console, and not the spirit realm.

 

/clients

See how many clients there are connected.

 

/accounts

View all the server accounts - Land and Bank accounts.

 

/clear

Clear the text away. This can make the server run smoother if there's a lot of text. Spirits can remotely do these commands to, thus they can clear the text buffer.

 

/bank

See the world bank balance. This is basically the amount of Markarigans (currency) that have been spent by players to the server in total. This can be fun to watch increase as time goes on.

 

/clock [time value]

Excactly the same as the /god weather command. The time value is a number between 0 and 72000000. 1000000 (one million) would be daytime.

 

 

IRC Console Commands

These commands are more of the IRC (spirit realm) nature. They are used in the same way.

 

 

/irc port [number]

Set the remote port to connect to. For example 6667.

 

/irc localport [number]

Set the localport to connect from. Any number will do I guess.

 

/irc channel [#channel]

Set the main spirit channel to join.

 

/irc host [ip/host]

What IRC server host or IP do we connect to for IRC?

 

/irc nick [nickname]

Choose a nickname

 

/irc ident [name]

Choose an ident. Bot will do.

 

/irc prayerchannel [#channel]

Choose an additional channel to join to send prayers too. A local channel where spirits hang out is usually a good idea, just incase they aren't paying attention to the main spirit channel.

 

/irc servicechannel [#channel] (NEW COMMAND)

Choose an additional channel for service spam output.

 

/irc defaults

Set a bunch of defaults which are built in. These will probably mean nothing by the time Hymené is finished, just for testing. Don't bother using it because irc.cfg is loaded these days. (you can change irc values in there for auto config).

 

/irc connect

This will attempt to connect to the spirit realm irc server, and join the channels.

 

/irc quit

This will send a QUIT: line to officially quit IRC.

 

/irc close

This will close the socket to IRC. Best to do this if you wish to reconnect again.

 

/echo on

This will echo all your talking commands in the spirit channel back to you. It can get annoying in conversations so ...

 

/echo off

You can turn them off! Default is off anyway.

 

/irc writeconfig

This will save the irc config 'irc.cfg'. This config has all the irc settings, and the spirit admin list.

 

/irc loadconfig

This will load the irc config 'irc.cfg'.

 

Irc Raw Commands

You can send a raw IRC packet by using .[packet]. Be careful, you can serious mess up the connection if you get it wrong.

Examples:       .JOIN #LOBBY

            .PRIVMSG #LOBBY :hiiiii

 

 

 

 

Spirit Commands

 

Now comes the spirit commands. People can do this in IRC. They can input any command in any channel that the bot has joined. The output might bounce back to them, or it might stream into the main Spirit channel. It all depends on the command. It's best to use commands in the main spirit channel usually, just so that you know the output. These commands you simply type in IRC.

 

.join [#channelname]

Tells the bot to join a channel.

 

.part [#channelname]

Tells the bot to part a channel.

 

.do you understand me?

If it understands you it will reply 'Roger' to you. If not, then spirit commands aren't working.

 

.say [words]

You can use .say if you wish to talk to the Hymené world from another channel, but if you are in the main spirit channel, you can simply type whatever it is you want to say.

 

.god [god command]

This will allow you to perform a God command. You will be a default of level 3 (Nephilim) but if your nickname is recognised in the Spirit List, you can have up to level 8.

 

When you use a God command, the spirit name enters the last client in the database (currently client id #1000), and does the command. You can always see this by doing /god id 1000. As with normal God commands, you can target someone if you need to, which I will explain shortly.

 

.target [id of target]

This allows you to set the spirit target by using thier ID number instead of name. Because spirits all share the same body to do commands, make sure you dont interfear with another spirits operation, or there might be confusion. Take it in turns to do what you want to do to players.

 

.touch [name of target]

Set the target by name, just like the angel command.

 

.console [raw console command]

(Level 7+)

This allows you to enter a raw server command (as explained above) as if you were sitting at the server itself. You need at least level 7 Spirit Access to do this. This makes spirits very powerful over the server console itself, so be wary of who you make into Level 7 spirits - in ways they are as powerful than God-Eights.

 

.angel [angel command]

You can do angel commands just like you can do God commands, providing you have the equivilent Spirit Access.

 

.agive [angelic gift]

You can also do angelic gifts in the same way with the right access. Make sure you select a target first by using .target and not /touch.

 

.spirit list

View the spirit list. This is a list of names with access to spirit commands.

 

.spirit add [level] [name]

(Level 4+)

You need at least spirit level 4, and you can only add someone the SAME or lower than yourself. Yes - unlike the oper list, spirits CAN add people the same level as themselves.

 

.spirit remove [name]

(Level 4+)

This will search and remove a person of that name from the spirit list. You cannot remove someone who is higher than you.

 

.spirit level

Type this to check your spirit level.

 

.adminraw [packet]

Send a raw admin packet to the server under your spirit name and spirit level. Without spirit access you will probably have level 3. It calls the sub 'adminstuff' which is all the player admin commands. Don't mess around with this, you probably wont need it. You might crash the game if you get it wrong.

 

.version

See the version of the server.

 

.protocol

(Level 7+)

See the protocol of the server. This is a 3-char word that must match clients in order for them to connect. If Hymené undergoes massive patches where old clients are unfair, the constant variable of protocol will be changed with the clients and servers so that only newer clients can work with it.

 

 

 

Useful Commands

 

These are some generally useful commands that you might want to know about, since you will be using them more often than most commands.

 

 

 

For spirits in irc

 

.console /irc channel #hello

Use this to change the spirit channel on irc (to #hello here), so that the output goes somewhere else.

 

.console .JOIN #newchannel

Use this to make the bot join an additional channel to idle in and recieve commands.

 

.console /irc writeconfig

Save the irc config after making changes.

 

 

For god clients in-game

 

/god console /irc connect

Use this to make the irc bot connect if it isn't connected.