Browse Source

Move otclientrc.lua to top dir

* Use markdown for README
Eduardo Bart 8 years ago
parent
commit
6f12261aef
5 changed files with 26 additions and 23 deletions
  1. 1
    0
      .gitignore
  2. 18
    19
      README.md
  3. 5
    3
      init.lua
  4. 1
    0
      modules/client/client.lua
  5. 1
    1
      otclientrc.lua

+ 1
- 0
.gitignore View File

@@ -21,6 +21,7 @@ CMakeLists.txt.user*
21 21
 *.otb
22 22
 *.otbm
23 23
 *.log
24
+*.bak
24 25
 /modules/myconfig.otml
25 26
 /modules/myotclientrc.lua
26 27
 !.gitignore

README.rdoc → README.md View File

@@ -1,4 +1,4 @@
1
-== What is OTClient?
1
+### What is OTClient?
2 2
 
3 3
 OTClient is an alternative Tibia client for usage with otserv. It aims to be complete and flexible,
4 4
 for that it uses LUA scripting for all game interface functionality and configurations files with a syntax
@@ -7,7 +7,7 @@ that each functionality is a separated module, giving the possibility to users m
7 7
 anything easily. Users can also create new mods and extend game interface for their own purposes.
8 8
 OTClient is written in C++2011, the upcoming C++ standard and heavily scripted in lua.
9 9
 
10
-== Features
10
+### Features
11 11
 
12 12
 Beyond of it's flexibility with scripts, otclient comes with tons of other features that make possible
13 13
 the creation of new client side stuff in otserv that was not possible before. These include,
@@ -17,34 +17,33 @@ run on mobile platforms like Androi/iPhon/iPad and much more. Otclient is also f
17 17
 create tibia tools like map editors just using scripts, because it wasn't designed to be just a
18 18
 client, instead otclient was designed to be a combination of a framework and tibia APIs.
19 19
 
20
-== Download
20
+### Download
21 21
 
22 22
 Daily snapshots of otclient master branch compiled for Windows and protocol 860 is available
23 23
 in the {downloads section}[https://github.com/edubart/otclient/downloads] of the project's github page.
24 24
 For any other platform or protocol you will need to compile the source code. Currently Linux/Windows
25 25
 platforms and protocols 860/861/862 are supported.
26 26
 
27
-== Compiling
27
+### Compiling
28 28
 
29 29
 In short, if you need to compile OTClient, follow these tutorials:
30
-* {Compiling on Windows}[http://otclient.info/index.php?app=ccs&module=pages&section=pages&id=2&record=9]
31
-* {Compiling on Ubuntu}[http://otclient.info/index.php?app=ccs&module=pages&section=pages&id=2&record=12]
30
+* [Compiling on Windows](http://otclient.info/index.php?app=ccs&module=pages&section=pages&id=2&record=9)
31
+* [Compiling on Ubuntu](http://otclient.info/index.php?app=ccs&module=pages&section=pages&id=2&record=12)
32 32
 
33
-== Need help?
33
+### Need help?
34 34
 
35
-Checkout our website at {http://otclient.info}[http://otclient.info/] for tutorials and more information.
35
+Checkout our website at <http://otclient.info> for tutorials and more information.
36 36
 If you have any questions or are looking for more information, please feel free to ask on our official
37
-forum at http://otclient.info or talk with us at #otclient irc.freenode.net
37
+forum at <http://otclient.info> or talk with us at #otclient irc.freenode.net
38 38
 
39
-== Bugs
39
+### Bugs
40 40
 
41
-Have found a bug? Please create an issue in our bug tracker
42
-http://otclient.info/tracker
41
+Have found a bug? Please create an issue in our [bug tracker](http://otclient.info/tracker)
43 42
 
44
-== Contributing
43
+### Contributing
45 44
 
46 45
 We encourage you to contribute to OTClient! Please check out
47
-{our website}[http://otclient.info/] for guidelines about how to proceed. Join us!
46
+[our website](http://otclient.info/) for guidelines about how to proceed. Join us!
48 47
 
49 48
 We are currently needing help in the following areas:
50 49
 * Designing new UI themes or improving the current one
@@ -55,18 +54,18 @@ We are currently needing help in the following areas:
55 54
 * Spreading otclient project over the web and bring it to new possible contributors
56 55
 * Testing the client itself to report bugs and missing features in our bug tracker
57 56
 
58
-== Contact
57
+### Contact
59 58
 
60
-You have 3 options, use the forum at http://otclient.info , talk directly with us at
61
-#otclient irc.freenode.net or send an email directly to the project leader edub4rt@gmail.com
59
+You have 3 options, use the forum at http://otclient.info , talk directly with us at #otclient irc.freenode.net
60
+or send an email directly to the project leader edub4rt@gmail.com
62 61
 
63
-== License
62
+### License
64 63
 
65 64
 OTClient is made available under the MIT License, thus this means that you are free
66 65
 to do whatever you want, commercial, non-commercial, closed or open.
67 66
 
68 67
 
69
-== Donate
68
+### Donate
70 69
 
71 70
 OTClient needs your support, if you really like and use it, please donate. Anyone can donate
72 71
 by clicking the Donate button in otclient website. We might prioritize features

+ 5
- 3
init.lua View File

@@ -12,9 +12,12 @@ g_logger.setLogFile(g_resources.getWorkDir() .. g_app.getCompactName() .. ".log"
12 12
 -- print first terminal message
13 13
 g_logger.info(g_app.getName() .. ' ' .. g_app.getVersion() .. ' (rev ' .. g_app.getBuildRevision() .. ') built on ' .. g_app.getBuildDate())
14 14
 
15
+--add base folder to search path
16
+g_resources.addToSearchPath(g_resources.getWorkDir())
17
+
15 18
 -- add modules directory to the search path
16 19
 if not g_resources.addToSearchPath(g_resources.getWorkDir() .. "modules", true) then
17
-    g_logger.fatal("Unable to add modules directory to the search path.")
20
+  g_logger.fatal("Unable to add modules directory to the search path.")
18 21
 end
19 22
 
20 23
 -- try to add addons path too
@@ -44,6 +47,5 @@ g_modules.ensureModuleLoaded("game")
44 47
 g_modules.autoLoadModules(9999)
45 48
 
46 49
 if g_resources.fileExists("/otclientrc.lua") then
47
-    dofile("/otclientrc.lua")
50
+  dofile("/otclientrc.lua")
48 51
 end
49
-

+ 1
- 0
modules/client/client.lua View File

@@ -34,6 +34,7 @@ function Client.init()
34 34
 
35 35
   g_window.setTitle('OTClient')
36 36
   g_window.setIcon(resolvepath('clienticon.png'))
37
+  g_keyboard.bindKeyDown('Ctrl+Shift+R', Client.reloadScripts)
37 38
 
38 39
   addEvent(function()
39 40
     scheduleEvent(function()

modules/otclientrc.lua → otclientrc.lua View File

@@ -1,4 +1,4 @@
1 1
 -- this file is loaded after all modules are loaded and initialized
2 2
 -- you can place any custom user code here
3 3
 
4
-g_keyboard.bindKeyDown('Ctrl+Shift+R', Client.reloadScripts)
4
+print 'Startup done :]'

Loading…
Cancel
Save