You are here

Home » API reference » User Points 7.2

README.txt in User Points 7.2

Same filename and directory in other branches
  1. 5.3 README.txt
  2. 5 README.txt
  3. 5.2 README.txt
  4. 6 README.txt
  5. 7 README.txt
Copyright 2005-2008 http://2bits.com

Description
-----------
The userpoints and userpoints_nc module provides the ability for users to gain
points with the do certain actions, such as:

- posting a node (different points can be awarded for different
  node types, e.g. page, story, forum, image, ...etc.)
- posting a comment
- moderating a comment

Upon deleting a node or a comment the number of points is subtracted.
If a node or comment author is changed points are transferred respectively

The number of points for each of the above actions is configurable by
the site adminsitrator.

A transaction log is created for each event. The log is viewable by
the admin.

Points can be moderated, i.e. approval can be done by the admin at a later
time.

A block displays the number of points the user gained. Another block 
displays the top 5 users who earned points.

----
Using modules from the project http://drupal.org/project/userpoints_contrib 
point can be awarded for other actions. 
including:
- voting on a node (requires the nodevote module)
- referring a person to the site (requires referral module)
- a visitor comes to the site via clicking on an affiliate link
  (requires the affiliates module)
- voting up or down a node (requires the vote_up_down module)
- inviting a person to register on the site (requires invite module)
- invited person actually registers on the site
- purchasing from your e-commerce store (reward points)

Using real money, users can purchase points from your ecommerce store
as well. Moreover, the points can be used as currency for ecommerce as well,
as in a form of payment

This module is useful in providing an incentive for users to participate
in the site, and be more active. The module is easily extended through use of 
the API (see below)

Initially sponsored by: http://artalyst.com

Installation
------------
To install this module, do the following:

1. Extract the tar ball that you downloaded from Drupal.org.

2. Upload the userpoints directory and all its contents to your
   modules directory.

Configuration
-------------
To enable this module do the following:

1. Go to Admin -> Modules, and enable userpoints.
   Check the messages to make sure that you did not get any errors
   on database creation.

2. Go to Admin -> Configuration -> People -> userpoints.

   Configure the options as per your requirements

3. Go to Admin -> People -> Permissions and configure as desired.

API
---

The API documentation can be found at api.worldempire.ch/api/userpoints.


Bugs/Features/Patches:
----------------------
If you want to report bugs, feature requests, or submit a patch, please do so
at the project page on drupal.org.
http://drupal.org/project/userpoints

Author
------
Khalid Baheyeldin (http://baheyeldin.com/khalid and http://2bits.com)

The Drupal 7 version of this module are maintained by Berdir
(http://drupal.org/user/214652).

If you use this module, find it useful, and want to send the author
a thank you note, then use the Feedback/Contact page at the URL above.

The author can also be contacted for paid customizations of this
and other modules.

File

README.txt
View source 
  1. 

  2. Copyright 2005-2008 http://2bits.com

  3. 

  4. Description

  5. -----------

  6. The userpoints and userpoints_nc module provides the ability for users to gain

  7. points with the do certain actions, such as:

  8. 

  9. - posting a node (different points can be awarded for different

  10.   node types, e.g. page, story, forum, image, ...etc.)

  11. - posting a comment

  12. - moderating a comment

  13. 

  14. Upon deleting a node or a comment the number of points is subtracted.

  15. If a node or comment author is changed points are transferred respectively

  16. 

  17. The number of points for each of the above actions is configurable by

  18. the site adminsitrator.

  19. 

  20. A transaction log is created for each event. The log is viewable by

  21. the admin.

  22. 

  23. Points can be moderated, i.e. approval can be done by the admin at a later

  24. time.

  25. 

  26. A block displays the number of points the user gained. Another block 

  27. displays the top 5 users who earned points.

  28. 

  29. ----

  30. Using modules from the project http://drupal.org/project/userpoints_contrib 

  31. point can be awarded for other actions. 

  32. including:

  33. - voting on a node (requires the nodevote module)

  34. - referring a person to the site (requires referral module)

  35. - a visitor comes to the site via clicking on an affiliate link

  36.   (requires the affiliates module)

  37. - voting up or down a node (requires the vote_up_down module)

  38. - inviting a person to register on the site (requires invite module)

  39. - invited person actually registers on the site

  40. - purchasing from your e-commerce store (reward points)

  41. 

  42. Using real money, users can purchase points from your ecommerce store

  43. as well. Moreover, the points can be used as currency for ecommerce as well,

  44. as in a form of payment

  45. 

  46. This module is useful in providing an incentive for users to participate

  47. in the site, and be more active. The module is easily extended through use of 

  48. the API (see below)

  49. 

  50. Initially sponsored by: http://artalyst.com

  51. 

  52. Installation

  53. ------------

  54. To install this module, do the following:

  55. 

  56. 1. Extract the tar ball that you downloaded from Drupal.org.

  57. 

  58. 2. Upload the userpoints directory and all its contents to your

  59.    modules directory.

  60. 

  61. Configuration

  62. -------------

  63. To enable this module do the following:

  64. 

  65. 1. Go to Admin -> Modules, and enable userpoints.

  66.    Check the messages to make sure that you did not get any errors

  67.    on database creation.

  68. 

  69. 2. Go to Admin -> Configuration -> People -> userpoints.

  70. 

  71.    Configure the options as per your requirements

  72. 

  73. 3. Go to Admin -> People -> Permissions and configure as desired.

  74. 

  75. API

  76. ---

  77. 

  78. The API documentation can be found at api.worldempire.ch/api/userpoints.

  79. 

  80. 

  81. Bugs/Features/Patches:

  82. ----------------------

  83. If you want to report bugs, feature requests, or submit a patch, please do so

  84. at the project page on drupal.org.

  85. http://drupal.org/project/userpoints

  86. 

  87. Author

  88. ------

  89. Khalid Baheyeldin (http://baheyeldin.com/khalid and http://2bits.com)

  90. 

  91. The Drupal 7 version of this module are maintained by Berdir

  92. (http://drupal.org/user/214652).

  93. 

  94. If you use this module, find it useful, and want to send the author

  95. a thank you note, then use the Feedback/Contact page at the URL above.

  96. 

  97. The author can also be contacted for paid customizations of this

  98. and other modules.