Ephemeral

Ephemeral 2.1 New stuff and added tutorial

2008-03-17T02:47:00.000-07:00

Hello again !

I've been busy for some time now, but I'm coming here with great news : The new version of Ephemeral is out.

List of changes since last version :

- Bug Fixes :
- The right-click menu can now be used when groupped.

- Localization :
- Added a localization.lua. The localization - in French for now - partially works, but will need some more work for the addon to be fully translated.

- Props API.

- I am currently adding some wrappers and new functions for an easier use of the Props scripting.

Ephemeral API

You can either use these functions by the "/script" command, or use them by scripting Props.

/!\ Parameters between [Brackets] are optional.

- Emote ( )
--> Wrapper that works like a "/e" command.

- Say ( )
--> Wrapper that works like a "/s" command.

Action( [, [, ] ] )
--> Send an Ephemeral broadcast for an anonymous RP action.
: description of the action
: true or false. If true, send both a chat message descripting the action, and an on-screen notice.
: "Zone", "target", or "playerName". If set to "Zone", will broadcast the action to all Ephemeral users in the zone (ie Stormwind City). If set to "target", will only send the descripted action to current target. If "playerName", will send the action to the specified player, no matter if he's the current target or not.

By default : = false and = nil. This means that the action will be sent either to the current zone (if no target), or the selected player (if there is a target).

- Sound ( [, [, ] ] )
--> Will broadcast a sound to the selected Ephemeral user(s).
: Relative path for the sound (can be a .wav or .mp3 from a Blizzard mpq)
: If true, send and an on-screen notice telling to turn on the sound.
: "Zone", "target", or "playerName". If set to "Zone", will broadcast the sound to all Ephemeral users in the zone (ie Stormwind City). If set to "target", will only send the sound to current target. If "playerName", will play the sound to the specified player, no matter if he's the current target or not.

- Music ( [, [, ] ] )
--> Will broadcast a music to the selected Ephemeral user(s).
: Relative path for the music (can be a .wav or .mp3 from a Blizzard mpq)
: true or false. If true, send and an on-screen notice telling to turn on the sound.
: "Zone", "target", or "playerName". If set to "Zone", will broadcast the action to all Ephemeral users in the zone (ie Stormwind City). If set to "target", will only send the music to current target. If "playerName", will play the music to the specified player, no matter if he's the current target or not.

Example Prop scripts :

Ex. 1, a poisoned beer.

local playerName = UnitName("player");
Emote(playerName.." is slowly drinking a beer, but seems to be shaking.");
Sound("Sound\\interface\\iDrinking1.wav");
Say("What the...");
Action(playerName.." has been poisoned and has fallen on the ground.", true, "Zone");

Ex. 2, a corrupted sword.

local playerName = UnitName("player"); -- We get the name of the player.
Sound("Sound\\Creature\\Ashbringer\\ASH_SPEAK_01.wav", true, "Zone")
Music("Sound\\Creature\\Voidwalker_VoidWraith\\VoidWalkerLoop.wav", false, "Zone")

local resist = math.random(100) -- test to see if the player is mentally strong enough
if resist > 80 then -- the player has 20% chance to have the sword obey him.
Say("Shut up, cursed sword. You WILL obey me.")
else -- game over :)
Emote(playerName.." is looking at the runesword, slowly smiling as he feels its unholy power flowing in his veins")
Say("Yes... I will kill them all... One - by - one." )
end

Don't hesitate to try out new things !

Good luck :)

Le guide en français !

2008-01-18T05:25:00.000-08:00

[ For the english version of the guide, click here ]

Bonjour à tous.

Ephemeral est un addon roleplay World of Warcraft développé il y a longtemps, en 2005, et qui permet la création d'objets roleplay.
Il est resté dans un état semi-fonctionnel pendant ces deux longues années, mais cette nouvelle version, l'a enfin rendu fonctionnel. Il est désormais compatible avec Burning Crusade et les derniers patchs.

Parlons maintenant de l'utilisation de l'addon (car il y a fort à parier que vous êtes ici pour ça).

TELECHARGEMENTS

Vous pouvez télécharger l'addon à partir de Curse Gaming : http://www.curse.com/downloads/details/8422/

LE GUIDE D'UTILISATION

- Ouvrir l'inventaire Ephemeral

A coté de la minimap, vous avez une petite icône, en forme de sac. Cliquer dessus vous permet d'ouvrir l'interface principale, comportant un inventaire, un bouton option sur le dessus, et deux boutons "Create" et "Explore, en dessous.

-> Le menu "Create"
Cliquer sur le bouton "Create" affiche le menu de création. A partir de celui ci, vous pouvez sélectionner le type d'objet que vous désirez créer :

- Book (Livre) : Permet de créer un livre entièrement personnalisable, sans limite de texte ni de taille. Le matériau est sélectionnable (Parchemin, pierre, métal, etc.), vous pouvez le mettre en lecture seule ou non, lui attribuer une couverture et décider de son nombre de pages.

- Container (Conteneur) : Vous voulez créer un coffre, avec un, ou plusieurs objets Ephemeral à l'intérieur ? Cette fonctionnalité est la pour ça. Vous pouvez créer tout types de conteneurs, choisir s'ils sont fermables ou non, vous pouvez les remplir, les fermer à clef et les envoyer à un autre utilisateur d'Ephemeral. S'il est verrouillé, il faudra la clef adéquat pour le rouvrir et récupérer les objets y étant scellés.

- Key (Clef) : Vous pouvez créer une clef, permettant de verrouiller / deverrouiller un conteneur.
/!\ POUR VERROUILLER/DEVERROUILLER UN CONTENEUR, FAITES D'ABORD UN CLIC GAUCHE SUR LA CLEF, PUIS UN CLIC DROIT SUR LE CONTENEUR.

- Intrument : Un objet personnalisable, exécutant des '/dire' ou des '/emote' dans un ordre précis (à chaque utilisation), ou aléatoire.

/!\ Si vous voulez qu'une ligne soit une commande '/emote', plutot qu'une commande '/dire', mettez un '*' au début de votre phrase.
Par exemple, si vous prenez

Je suis le roi du monde !
*écarte les bras en affichant un sourire niais.

Quand vous utiliserez l'instrument, il exécutera une de ces deux actions :
- /dire Je suis le roi du monde !
- /emote écarte les bras en affichant un sourire niais.

Exemple d'utilisation : Vous pouvez créer une guitare qui, si utilisée, fait chanter le joueur en lançant des /dire et des /emote aléatoires. Vous pouvez également faire de même pour un engin quelconque, du poison, etc. Bien évidement, la personne recevant l'Instrument ne connait pas à l'avance son effet.

- Props (Objet): Si les possibilitées de l'instruments vous sont trop restrictives, vous pouvez créer des objets scriptables. Le scriptage d'objet nécéssite des connaissances de programmation lua, puisqu'ils permettent de scripter un objet directement à partir du jeu. En revanche, un utilisateur avancé peut faire des merveilles avec ceci.

C'est à peu près tout ce qu'il est possible de faire via Ephemeral.
Quelques fonctions lua / WoW API utiles pour le scripting d'objets (Props) :

- SendChatMessage()
- ep.Message("Text") <- Très utile, affiche une ligne de texte directement à l'utilisateur, sans commande chat. - PlaySoundFile("file.mp3") (Les differents FX et musiques de WoW sont disponibles ici )

Vous pouvez jeter un oeil sur WowWiki (Anglais) pour des références lua / WoW API.

L'Explorer d'objets

Le deuxième boutton, en bas de votre inventaire Ephemeral, vous affiche un explorer, façon Windows.
A partir de cet explorer, vous pouvez intéragir avec vos objets en effectuant un clic droit. Il est ainsi possible d'envoyer des objets, les organiser ou encore les détruire.

(Une documentation plus complète sera bientôt disponible)

Utile à savoir

Comment verrouiller un conteneur ?

Pour verrouiller / déverrouiller un conteneur, vous devez d'abord le rendre 'fermable'. Ensuite, vous devez créer une clef.

Ces deux objets en main, faites D'ABORD un clic gauche sur la clef, PUIS un clic droit sur le conteneur. Même chose pour dévérrouiller un conteneur.

Comment envoyer un objet ?

Deux solutions :
- D'abord, passer par l'explorer d'objets, puis faire un clic droit. Un menu contextuel apparaitra.
- Ou, depuis l'inventaire principal, faire MAJ - Clic droit sur un objet, pour faire apparaitre ce même menu contextuel.

Choses à savoir !!

Un des (rares) bugs restant concerne la Blacklist/Whitelist. En attendant sa réparation prochaine, évitez d'utiliser ces fonctions ( Comme l'invite, lors de la réception d'un objet, qui nous propose de toujours accepter les objets de tel utilisateur )

C'est à peu près tout pour le moment. J'amméliorerai ce guide avec des images dès que j'aurais un peu de temps devant moi.

En attendant, faites du roleplay et bienvenue dans le monde (merveilleux ?) d'Ephemeral !

The English User-Guide !

2008-01-17T11:59:00.000-08:00

[ Pour la version française, cliquez ici ]

Hi everyone.

Ephemeral is a World of Warcrafy roleplay addon that was made long ago, in 2005, and that enables the creation of Roleplay items.
It has been in a semi-working state for these two long years, but, with this "Renaissance" Edition, you have a fully working Ephemeral ! Compatible with TBC and last patches.

Now, let's talk about "How to use the addon", because I think you are here for that.

DOWNLOADS

You can download the addon from here : http://www.curse.com/downloads/details/8422/

THE USER GUIDE

- Opening the backpack / Ephemeral :

There is a small "Backpack" Icon available near the minimap. Clicking on it shows the Ephemeral interface, which consist of a small backpack, with two buttons on the bottom and one button "Option" on the top.

-> The "Create" Menu
Clicking on "Create" shows the creation menu. Here you can choose several types of items to create :

- Books : You can create fully customisable books, with unlimited text length. The material of the book is customizable (Parchment, Marble, Steel...), you can choose to make it read-only or not, you can make a cover, and write any number of pages.

- Container : Want to make a locked treasure chest, with an Ephemeral object inside ? Then this is for you. You can make any container, choose to make it lockable or not, you can fill it, lock it, and send it to any other Ephemeral user. If locked, the target player will need the special key you made to get the objects inside.

- Key : You can create keys, made to lock and unlock containers.
/!\ TO LOCK/UNLOCK A CONTAINER, FIRST LEFT-CLICK THE KEY, THEN RIGHT CLICK THE CONTAINER

- Intrument : A customizable item that, if used, makes the player /say or /emote, any number of sentence. The sentences can be played randomly or by linear.

/!\ If you want a line to be an emote, instead of regular '/say' message, just type '*' at the beginning of the line.
For example, if you have

I am the king of the world !
*spreads his arms and has a stupid smile on his face.

When you will use the Instrument, it will show randomly (or not) :
- /say I am the king of the world !
- /emote spreads his arms and has a stupid smile on his face.

Example : you can make a guitar that, if used, makes the player sing random lyrics, and emote random things. Another example would be a vial of poison that, if used, makes the targetplayer emote "Foo opens a little vial and inhale a deadly poison".

- Props : If the insrument is not enough, you can make scripted items. Props scripting should be only used by lua programmers, since it enables direct scripting. An advanced user can make wonders with this.

That's basically all the things you can do with Ephemeral.
Some usefull WOW API functions for props scripting :

- SendChatMessage()
- ep.Message("Text") <- Very usefull, this one shows text to the user only. Not a chat message - PlaySoundFile("file.mp3") (All the music files for wow are here )

You can check WowWiki for more lua / WoW API references.

The Item Explorer

The second button, in the bottom of the Backpack screen, shows an Item Explorer.
From here, you can send items to other players, you can organize yours, and even destroy them.
I'll make a full documentation soon, but I'm pretty sure you can figure out most of the things it does.

Interface Tips

How to lock a container ?

To Lock / Unlock a container, you must first make the container 'lockable'. Then, you have to create a Key.

When you have all the elements, FIRST left click the key, THEN right-click the container. It will do the job, asuming you have the right key.

How to send an item ?

You have two choice :
- First, you can use the explorer, and right click the item, a context menu will appear.
- Second, from the main inventory, you can shift - right click an item to show the same context menu.

Things to know !!

One of the (few ) remaining bugs are from the Whitelist/Blacklist. So, please, do not use this feature now. It will be fixed in the near future, but it isn't right now.
So, please avoid ticking the "Remember my decision"-like checkbox when receiving an item.

Well, that's all for now. I will improve the guide with screenshot, as soon as I find the time to do so. Of course, if someone is nice enough to do it for me ... well, keep me informed !

So, have a nice roleplay time, and welcome to the wonderfull world of Ephemeral !