Differences

This shows you the differences between two versions of the page.

--- virtualty:draw_me_raffle_system_-_user_manual [2022/06/29 10:53] – [DrawMe! Raffle Script] wikimaster
+++ virtualty:draw_me_raffle_system_-_user_manual [2024/08/15 14:58] (current) – updated for version 1.1 of the owner and the raffle wikimaster
@@ Line 1: / Line 1: @@
 ====== Draw me! Raffle system ======
-Script version: 0.1\\
+Draw Me! Owner Terminal version: 1.1i2\\
-Last update: 29/06/2022\\
+Draw Me! Raffle Script version: 1.1i8\\
+Last update: 15/08/2024\\
 “Draw me!” is a tool to create and manage Raffles for your shop/brand, for your events or for whatever other reason you may find to randomly distribute what you want to one of your customers\\
@@ Line 8: / Line 9: @@
 ==== Basic elements ====
-{{ :virtualty:drawme:screenshot_1.jpg?nolink&400 |}}
+{{:virtualty:drawme_2:screenshot_2.png?400|}}
 The tool is made of two elements:\\
-  * ''DrawMe! Owner Terminal'' - The Owner Terminal that will be used to create the new Raffles and to extract the winner
+  * ''DrawMe! Owner'' - The Owner Terminal that will be used to create the new Raffles and to extract the winner
   * ''DrawMe! Raffle Script ''  - The actual Raffle element. This is just a simple box, because you can decide to put the scripts that are inside it in another object and use it as a Raffle element
-  {{ :virtualty:drawme:screenshot_2.jpg?nolink&400 |}}
 Plus of course the Management website, that can be reached at\\
 https://manageme.virtualty.space/users/login.php\\
@@ Line 18: / Line 19: @@
 ==== Let's start ====
 The concept of this tool is to make as simple as possible to create and manage raffles.\\
-First and foremost, rez the Owner Terminal, and reset the scripts (I know, annoying, I will fix it in the next release)\\
+When you rez the Owner Terminal you will be requested to allow access to your linden account.\\
-{{ :virtualty:drawme:screenshot_9.jpg?nolink&400 |}}
+This of course to pay the fee every tme you will create a new raffle.
-{{ :virtualty:drawme:screenshot_22.jpg?nolink&600 |}}
+{{:virtualty:drawme_2:screenshot_1.png?400|}}
-You will be asked to allow to access your L$. This is of course to pay the fee for the raffles.\\
+==== Normal Operations ====
 Once you have done this, you are ready to start working with the Raffle.\\
 Clicking on the Owner Terminal a menu will show up:
-{{ :virtualty:drawme:screenshot_3.jpg?nolink&400 |}}
+{{:virtualty:drawme_2:screenshot_4.png?400|}}\\
 And from this menu you will be allowed to select one of the following options:\\
-  * ''List Raffles'' - Shows you the raffles you may have as active and inactive
+  * ''List'' - Shows your active raffles and allows to access a menu that is Reffle related
-  * ''New Raffle'' - Creates a new raffle (**__ATTENTION__** This is the moment you will be billed)
+  * ''New'' - Creates a new raffle (**__ATTENTION__** This is the moment you will be billed)
-  * ''Activate Raffle'' - After creating a raffle, and having defined all the parameters and characteristic of the raffle, you will select this button to actually activate the selected raffle
+{{:virtualty:drawme_2:screenshot_4.png?400|}}
-  * ''Draw Raffle'' - From this button you will actually pick the winner
+=== New Raffle ===
+When you click on the ''New'' button (surprise surprise!) you will be asked to name your new raffle
+{{:virtualty:drawme_2:screenshot_5.png?400|}}\\
+A message from the postmaster will confirm that it has been created.
+{{:virtualty:drawme_2:screenshot_6.png?400|}}\\
+**PLEASE NOTE** The Raffle has NOT been activated, it has just been created.\\
+The reason why the raffle is not active the moment you create it, is because you may want to change who is allowed to access it (aka everybody or only people in a specific group), hence I prefer you to manually activate it in Manage Me! in order to you to be completely sure what you are doing.
+In Manage Me!, when you find your newly create raffle in the inactive pool, you will see that is by default set to ''manual''
+{{:virtualty:drawme_2:screenshot_8.png?400|}}
+{{:virtualty:drawme_2:screenshot_9.png?400|}}
 === List Raffles ===
 Clicking this button you will receive in world the list of active and inactive raffles.\\
 Please note that of course the result may easily be 0, if you have no raffles in that states\\
-Please also note that old raffles (archived ones) can be seen only in the web interface
+Please also note that old raffles (archived ones) and inactive raffles can be seen in the Manage Me!
-^ In world message      ^ Manage Me interface        ^
+{{:virtualty:drawme_2:screenshot_15.png?400|}}
-| {{ :virtualty:drawme:screenshot_4.jpg?nolink&400 |}}    | {{ :virtualty:drawme:screenshot_5.jpg?nolink&400 |}}     |
-=== New Raffle ===
-When you click on this button (surprise surprise!) you will be asked to name your new raffle
-{{ :virtualty:drawme:screenshot_6.jpg?nolink&400 |}}
-A message from the postmaster will confirm that it has been created.
-{{ :virtualty:drawme:screenshot_7.jpg?nolink&400 |}}
-**PLEASE NOTE** The Raffle has NOT been activated, it has just been created.\\
-The reason why the raffle is not active the moment you create it, is because you may want to change who is allowed to access it (aka everybody or only people in a specific group), hence I prefer you to manually activate it in order to you to be completely sure what you are doing.
 === Activate Raffle ===
 Once you have created the Raffle, you can activate it.\\
-Selecting the ''Activate Raffle'' button a new dialog will be shown.\\
+To do that, you will have to go to Manage Me!.\\
-If you have several raffle to activate, you will have more than one element, and of course more than one button
+{{:virtualty:drawme_2:screenshot_9.png?400|}}
-{{ :virtualty:drawme:screenshot_10.jpg?nolink&400 |}}
+Once in the Draw Me! section, clicking on ''Inactive'' you will see the list of inactive raffles.\\
-and a message in world will inform you that everything is active
+Simply press the appropriate button to have the selected raffle activated.
-{{ :virtualty:drawme:screenshot_11.jpg?nolink&400 |}}
+{{ :virtualty:drawme_1:screenshot_6.png?400 |}}
-You can see that the raffle is active also clicking on the button ''List Raffles''
+{{ :virtualty:drawme_1:screenshot_7.png?400 |}}
-{{ :virtualty:drawme:screenshot_12.jpg?nolink&400 |}}
-Next step will be to go to Manage Me! to define who will be allowed to enrol in your Raffle
+=== Winner ===
+First you have to of course select the Raffle you want to search the winners for:
+{{ :virtualty:drawme_1:screenshot_8.png?400 |}}
+{{ :virtualty:drawme_1:screenshot_9.png?400 |}}
+{{ :virtualty:drawme_1:screenshot_10.png?400 |}}
+Of course according to what you have defined in Manage Me! you will have different results.\\
+In Particular, though, you will receive IMs informing who won, that the prize or the money have been sent, or just the message stating who is the winner:
+{{ :virtualty:drawme_1:screenshot_28.png?400 |}}
+You can see the total number of winners in the appropriate section in Manage Me!:
+{{ :virtualty:drawme_1:screenshot_17.png?400 |}}
+\\
+It also possible to decide the winner off line. This option is only selecting a (new) winner, it is NOT sending money or object to the winner of the raffle.\\
+{{:virtualty:drawme_3:screenshot_004.png?600|}}
+{{:virtualty:drawme_3:screenshot_005.png?600|}}
+=== List of Subscribers ===
+You can see the full list of subscribers by selecting the ''Complete list'' link:
+{{ :virtualty:drawme_2:screenshot_19.png?400 |}}
+From the list, you can also delete the Subscribers you want.\\
+{{ :virtualty:drawme_2:screenshot_18.png?400 |}}
+**ATTENTION**\\
+Delete a subscriber is irreversible!\\
+=== Deactivate ===
+Very simply, this button will ''Deactivate'' the selected raffle.\\
+Please remember that the raffle is *NOT* deactivated after you have selected the ''Winner'', so this is the *only* way you have to fully deactivate the raffle.\\
+=== Stats ===
+This is a very small section, only showing some quick statistics. For more stats, there is the Manage Me! part.
+{{ :virtualty:drawme_1:screenshot_30.png?400 |}}
+==== Give aways ====
+If you plan to give objects as prize for the raffle, remember that you have to place the object(s) in the Owner Terminal:
-=== Draw Raffle ===
-When you click on this button you will either be asked if you want to decide the winners of the raffle, OR decide to deactivate it.\\
-{{ :virtualty:drawme:screenshot_17.jpg?nolink&400 |}}
-  * ''Winners'' - Shows you the winner for the raffle
-  * ''Deactivate'' - Deactivated the specific raffle, so that it will NOT accept new users to enter it, and you can, later on, decide to draw the winner
 ==== Manage Me! ====
-''Manage Me!'' is the portal used to (surprise surprise) manage the different tools developed with Virtualty.\\
+''Manage Me!'' is the portal used to (surprise surprise) manage the different tools developed by Virtualty.\\
 You need only a password to access all the services we are offering you, to make it easier.\\
 \\
 \\
-In this case, when you log in ''Manage Me!'' and you access the ''Draw me!'' portion of the portal, you will be presented with two simple options:
+In this case, when you log in ''Manage Me!'' and you access the ''Draw me!'' portion of the portal, you will be presented with three simple options:
-{{ :virtualty:drawme:screenshot_18.jpg?nolink&400 |}}
+{{ :virtualty:drawme_1:screenshot_5.png?400 |}}
-  * ''Active Raffles'' - Shows you the active raffles and allows you to edit them
+  * ''Active'' - Shows you the active raffles and allows you to edit them
-  * ''Old Raffles'' - Link to the old, archived raffles, kept in memory for statistic purposes and so that you do not loose potential customers\\
+  * ''Inactive'' - Shows you the inactive raffles and allows you to edit them
+  * ''Old'' - Link to the old, archived raffles, kept in memory for statistic purposes and so that you do not loose potential customers\\
 === Active Raffles ===
-{{ :virtualty:drawme:screenshot_13.jpg?nolink&400 |}}
 Once you go to the ''Active Raffles'' section, you will be presented with the list of ALL the raffles you have active at the moment.\\
 In a glance you can see how many people already subscribed to it
-{{ :virtualty:drawme:screenshot_19.jpg?nolink&600 |}}
+{{ :virtualty:drawme_1:screenshot_31.png?400 |}}
 Clicking on the name of the Raffle, you will enter the specific page of the Raffle:
-{{ :virtualty:drawme:screenshot_14.jpg?nolink&600 |}}
+\\
 At the moment the only sections that are in use are:
   * ''Authentication'' - Determines the way you want to authorize people to enter your Raffle (if using a group or without authorization)
+  * ''Delayed start'' - Define the delayed starting date and time
+  * ''Automatic end'' - Define the automatic ending date and time of the raffle
+  * ''Winner'' - Shows the winner(s) or allows you to decide a (new) winner
   * ''Statistics'' - Shows
      * the total number of subscribers,
      * allows you to access to the complete list of subscribers
      * lists the last 10 ones
-     * shows the winner, if any
+     * shows the winner(s), if any
 == Authentication ==
 In this section you will have to decide who will be able to enrol in your raffle.\\
-{{ :virtualty:drawme:screenshot_15.jpg?nolink&600 |}}
+{{ :virtualty:drawme_1:screenshot_16.png?400 |}}
 If you select *None* then everybody will be able to enrol for the Raffle
 {{ :virtualty:drawme:screenshot_16.jpg?nolink&600 |}}
 If you select *Group* you HAVE to specify the group that will be used, and the SAME group will have to be used to rez the ''DrawMe! Raffle Script''
+== Delayed start ==
+If when you have rezzed and configured the Raffle Script you have decided for a Delayed start, here you can configure the start time.\\
+Of course this will have to be set up in SL Time and the script that opens the raffle will run every 10 minutes, to see if there is a new raffle to start or not.\\
+So please be aware that there may be a delay in the actual starting of the raffle.\\
+{{:virtualty:drawme_3:screenshot_003.png?600|}}
+== Automatic end ==
+You can also decide to have the raffle stop accepting subscribers at a specific date and time.\\
+As for the delayed start, you will have to set the SL Time you want the raffle to close\\
+== Prizes ==
+In this section you can specify what are the prizes for the winner(s) of the raffle.\\
+{{ :virtualty:drawme_1:screenshot_32.png?400 |}}
+You can select:
+  * ''Manual'' - You will just receive a message for a single winner
+  * ''Lindens'' - You specify the amount of lindens to give to the specified number of winners. *Please note* that this will be automatic. The winner(s) will eceive the money (if there is enough balance in your account)
+  * ''Object'' - You can specify the object (saved in the Owner Terminal) to give to the winner(s)
+Examples:\\
+{{ :virtualty:drawme_1:screenshot_12.png?400 |}}
+{{ :virtualty:drawme_1:screenshot_14.png?400 |}}
 ==== DrawMe! Raffle Script ====
 {{ :virtualty:drawme:screenshot_20.jpg?nolink&600 |}}
@@ Line 101: / Line 160: @@
 In this menu you will have all your active raffles, so just select the one you want to activate\\
 {{ :virtualty:drawme:screenshot_21.jpg?nolink&600 |}}
-Please note that you can have several ''DrawMe! Raffle Script'' associated to the same Raffle, if, for instance, you want to have the Raffle in several places
+Please note that you can have several ''DrawMe! Raffle Script'' associated to the same Raffle, if, for instance, you want to have the Raffle in several places.\\
+Once you click the raffle, a new pop up will show up, asking if you want to start the raffle immediately or if you want to have a delayed start, ska atart the raffle automatically in another moment:
+{{:virtualty:drawme_3:screenshot_001.png?600|}}
+If you select the delayed start, you **will** have to set up the desired time in Manage Me!\\
+If you have created different ''DrawMe! Raffle Script'' elements (for instance you have different places where people can join the raffle) you will have to select the Delayed option in all of them, while of course only set one date and time in Manage Me!.\\
+{{:virtualty:drawme_3:screenshot_002.png?600|}}
+If instead you select the option to start the Raffle immediately, you will see the following:
 {{ :virtualty:drawme:screenshot_23.jpg?nolink&600 |}}
+And after 30 seconds the raffle will be active.\\
 {{ :virtualty:drawme:screenshot_24.jpg?nolink&600 |}}
 \\
 \\
-When the owner clicks on the ''DrawMe! Raffle Script'' when this is associated to a Raffle, it will disable.\\
+When the owner clicks on the ''DrawMe! Raffle Script'' when this is associated to a Raffle, it will show a menu asking if you want to disable or test the raffle.\\
+If you will click on test, the owner of the raffle will be added to the raffle.\\
+Please remember to remove yourself from the raffle either clicking again on test or in Manage Me!.\\
 This is done so that you can temporarily disable the Raffle script for checking on the raffle itself, or in case you think there is a problem and you want to check with us first.
 {{ :virtualty:drawme:screenshot_25.jpg?nolink&600 |}}
@@ Line 114: / Line 180: @@
 {{ :virtualty:drawme:screenshot_26.jpg?nolink&600 |}}
 to reactivate the Raffle, the Owner just have to click again on the Raffle object
+ === Join the Raffle ===
+When an avatar that is not the Owner clicks on an associated ''DrawMe! Raffle Script'' object, they will enrol, and receive an appropriate message:
+{{ :virtualty:drawme:screenshot_27.jpg?nolink&600 |}}
+The system will moreover check if somebody is trying to enrol twice, and in case will send them a message:
+{{ :virtualty:drawme:screenshot_28.jpg?nolink&600 |}}