This library is currently a work-in-progress, please let us know if something does not work as expected or if you think a documentation article is lacking information.
There are currently 3 ways to get started:
- Clone the repository and compile the latest code (experimental)
- Download one of the stable releases and compile the code
- Use our NuGet package (compiling is not required)
Upgrading isn't always easy, especially not when dealing with libraries that change/remove function definitions and properties that you are using. You can quickly review all changes that may be relevant for you at the Migration Guide page of the wiki if you plan to upgrade.
These pages provide explanations and samples on how to properly use the library.
- Sessions and Library extensions
- Shoutbox
- Private Messages
- Blogs
- Sections
- Users and Ranks
- Profiles (Session Users)
- Threads
- The Black Market
- Contents
If something does not work correctly, please refer to our unit tests first which are located in the /test/UnitTests directory of the repository. We aim to update them simultaneously as the library grows so they also act as samples you may use.
In case you want to run the tests by yourself, create the text file credentials.txt in your %LocalAppData%/epvpapi folder and fill in your credentials in the following format:
<UserName>:<UserID>:<MD5PasswordHash>:<TBMAPISecretWord>
Example: Mostey:99999:FFFFFFFFFFFFFFFFFFFFFFFFFFF:mysecretword
The MIT License (MIT)
Copyright (c) 2014 - 2015
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.