Browse Source

Update README, TODO, AUTHORS

Eduardo Bart 7 years ago
parent
commit
c1ffcee645
5 changed files with 20 additions and 133 deletions
  1. 5
    2
      .gitignore
  2. 1
    3
      AUTHORS
  3. 1
    32
      BUGS
  4. 13
    13
      README.md
  5. 0
    83
      TODO

+ 5
- 2
.gitignore View File

@@ -23,8 +23,11 @@ CMakeLists.txt.user*
23 23
 *.otbm
24 24
 *.log
25 25
 *.bak
26
-/modules/myconfig.otml
27
-/modules/myotclientrc.lua
26
+*.swp
27
+config.otml
28
+/modules/otclientrc.lua
28 29
 !.gitignore
29 30
 otclient.map
30 31
 otclient.layout
32
+TODO
33
+LOCALTODO

+ 1
- 3
AUTHORS View File

@@ -1,3 +1 @@
1
-edubart - leader developer (project creator) <edub4rt@gmail.com>
2
-andrefaramir - scripting (implemented a lot of modules like battle, hotkeys, npctrade, chat) <andre_faramir@hotmail.com>
3
-baxnie - implemented first game functionality <henrique_santiago93@hotmail.com>
1
+See https://github.com/edubart/otclient/graphs/contributors

+ 1
- 32
BUGS View File

@@ -1,32 +1 @@
1
-== CRASHS
2
-modules recursivity makes client crash, it should generate a warning
3
-boost::asio makes the client crash in rarely conditions when trying to connect but internet is offline
4
-
5
-== P1 BUGS (affects game play)
6
-in some situations creatures may disappears while walking
7
-sometimes minimap desync Z pos
8
-follow and autowalk doesn't cancel when walking via hotkeys
9
-when reading invalid spr/dat the client crashs
10
-
11
-when walking on a tile with too many creatures, the following errors occurrs:
12
-ERROR: [ProtocolGame::parseCreatureHealth] could not get greature
13
-ERROR: [ProtocolGame::parseCreatureHealth] could not get greature
14
-ERROR: [Map::setCentralPosition] invalid creature
15
-ERROR: [Map::setCentralPosition] invalid creature
16
-ERROR: [Map::setCentralPosition] invalid creature
17
-ERROR: [Map::setCentralPosition] invalid creature
18
-
19
-
20
-== P2 BUGS
21
-battle sometimes doesn't clear attacked/followed creatures when they go out of range
22
-when looking from floor 5 in floor 7, sometimes a tile have 2 invisible grounds in floor 6 that should be ignored
23
-invisible creatures name offset is incorrect
24
-walk does not work properly when a creature is paralyzed
25
-
26
-== P3 BUGS
27
-widgets may have been destroyed when adding event in onSetup (UIResizeBorder), generating invalid events
28
-too many talk messages in game map make the messages boxes disappear
29
-hotkeys works while windows are locked, it shouldn't
30
-skulls is rendering outside map bounds
31
-party options does not work when re-logging inside a party
32
-sometimes we can still view hits from above/bottom floors from a fight that is not visible
1
+See https://github.com/edubart/otclient/issues

+ 13
- 13
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
@@ -20,53 +20,53 @@ client, instead otclient was designed to be a combination of a framework and tib
20 20
 ### Download
21 21
 
22 22
 Daily snapshots of otclient master branch compiled for Windows and protocol 860 is available
23
-in the {downloads section}[https://github.com/edubart/otclient/downloads] of the project's github page.
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
-platforms and protocols 860/861/862 are supported.
25
+platforms and protocols 8.6x are supported.
26 26
 
27 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/tutorials/compiling_on_windows.html)
31
+* [Compiling on Linux](http://otclient.info/tutorials/compiling_on_linux.html)
32 32
 
33 33
 ### Need help?
34 34
 
35 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://forum.otclient.info> or talk with us at #otclient irc.freenode.net
38 38
 
39 39
 ### Bugs
40 40
 
41
-Have found a bug? Please create an issue in our [bug tracker](http://otclient.info/tracker)
41
+Have found a bug? Please create an issue in our [bug tracker](https://github.com/edubart/otclient/issues)
42 42
 
43 43
 ### Contributing
44 44
 
45
-We encourage you to contribute to OTClient! Please check out
45
+We encourage you to contribute to otclient! Please check out
46 46
 [our website](http://otclient.info/) for guidelines about how to proceed. Join us!
47 47
 
48 48
 We are currently needing help in the following areas:
49 49
 * Designing new UI themes or improving the current one
50 50
 * Translating the client to other languages
51
-* Documenting lua APIs and creating tutorials
52
-* Scripting with lua new modules or improving the current ones
51
+* Documenting and creating tutorials
52
+* Scripting new modules or improving the current ones
53 53
 * Porting otclient to other otserv protocols (8.54, 8.7, 9.x, etc)
54 54
 * Spreading otclient project over the web and bring it to new possible contributors
55 55
 * Testing the client itself to report bugs and missing features in our bug tracker
56 56
 
57 57
 ### Contact
58 58
 
59
-You have 3 options, use the forum at http://otclient.info , talk directly with us at #otclient irc.freenode.net
59
+You have 3 options, use the [forum](http://forum.otclient.info/), talk directly with us at #otclient irc.freenode.net
60 60
 or send an email directly to the project leader edub4rt@gmail.com
61 61
 
62 62
 ### License
63 63
 
64
-OTClient is made available under the MIT License, thus this means that you are free
64
+Otclient is made available under the MIT License, thus this means that you are free
65 65
 to do whatever you want, commercial, non-commercial, closed or open.
66 66
 
67 67
 
68 68
 ### Donate
69 69
 
70
-OTClient needs your support, if you really like and use it, please donate. Anyone can donate
70
+Otclient needs your support, if you really like and use it, please donate. Anyone can donate
71 71
 by clicking the Donate button in otclient website. We might prioritize features
72 72
 requests from who donate, in this case you can send an email to the project leader.

+ 0
- 83
TODO View File

@@ -1,83 +0,0 @@
1
-== MODULES
2
-game_shaders (with shader manager)
3
-game_map (with save/load/options)
4
-game_minimap (with all tibia functionality)
5
-
6
-== NOTABLE FEATURES
7
-make left panel optional
8
-must close last container when opening a new containers
9
-move chat tabs
10
-save/load mini windows states/location when restarting the client
11
-load modules from zip files
12
-manual autoload setting in module manager
13
-complete a smarter miniwindow moving/resizing
14
-make miniwindow borderless on double click
15
-
16
-== BEFORE RELEASE
17
-polish interface skin
18
-new optional skin
19
-send otclient/system information to a third party server
20
-
21
-== LATER FEATURES
22
-reload spr/dat while ingame
23
-create and bind new game events
24
-text selection
25
-login queue
26
-port to MacOs and iphone
27
-allow multiple Map and Game instances ?
28
-
29
-== MINOR FEATURES
30
-display exit box when exiting from game
31
-load modules from zip packages
32
-move up/down in lineedits
33
-select characters in lineedits
34
-scrolling multiline edit
35
-mouse wheel lineedits
36
-onMapKnown event
37
-save different account/pasword/server for each otclient protocol version
38
-dont store textures upsidedown
39
-
40
-== OPTIMIZATIONS AND REWORKS
41
-* game
42
-do not redraw in MapView far zoom
43
-map zoom rendering could be optimized using framebuffer caches
44
-multisample option in map view
45
-move rendering of creatures names, skulls, etc to UI and scripts
46
-clean sprites cache periodically
47
-handle corrupt errors in dat/spr
48
-throw exceptions when fail to read a file
49
-fix C++ exceptions messages inside onExtendedOpcode
50
-rework outfit masks drawing
51
-complete rework on autowalk
52
-
53
-* framework
54
-rework Settings/g_configs
55
-platform cursor cache
56
-replace onKey events with Hotkeys.bind
57
-add -no-sound option
58
-rework lua/c++ logger
59
-
60
-* ui
61
-rework hover => onWidgetVisibilityChange onWidgetEnableChange onWidgetMove onAppear onDisappear
62
-reset dragging widget on destruction/visibility change/enable change
63
-cancel layout changes on non visible widgets (acts like it doesn't exist)
64
-add more anchors warnings to make creation of OTUIs easier
65
-review UI/style loader and make more error prone with more warnings
66
-change Align/Anchors lua API from enum to text
67
-review widgets rendering order, consider adding z-index
68
-reapply anchor styles when adding new childs
69
-style inheritance using a style translator
70
-find a way to add new widgets without focusing them
71
-make set of background/icon/image width alone work
72
-make api to enable/disable capture of events like mouseMove to avoid massive event processing
73
-move layout proprieties to widget style
74
-terminate rework of ui events propagation  (for Key events)
75
-
76
-* lua engine
77
-make possible to bind non LuaObject derived classes on lua engine (for usage with Point,Rect,Color,Size)
78
-review usage of x,y/width,height in lua instead of point/size
79
-
80
-* modules system
81
-use one isolated environment for each module
82
-
83
-

Loading…
Cancel
Save