Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve: readme infos #801

Merged
merged 37 commits into from
Aug 9, 2024
Merged

improve: readme infos #801

merged 37 commits into from
Aug 9, 2024

Conversation

kokekanon
Copy link
Collaborator

@kokekanon kokekanon commented Jul 3, 2024

note: when modifying the readme I realized that some comments were missing and added the shop server part

My part is ready, someone needs to modify this information that I'm unaware of.

missing element
remove or integrate new gifs
add Roadmap information
confirm information of "Support Protocol".
integrate this wiki Attached Effects
I did it about 3 months ago, I no longer have access to it to improve it.
to the main repo wiki

1) improve: Readme

demo :

https://github.com/kokekanon/otclient.readme/tree/readme3

requested by mehah about 3 months ago haha

Screenshot:

....

....

image

....

....

test

....


image

....

....

image

....

2) Add comments

add comments file
example attachParticleEffect: g_game.getLocalPlayer():attachParticleEffect("creature-effect") modules\game_attachedeffects\attachedeffects.lua
Add comment to minimap tfs c++ (old) :
void ProtocolGame::sendWorldTime()
tfs lua (new) :
function Player.sendWorldTime(self, time)
Canary:
void ProtocolGame::sendTibiaTime(int32_t time`)
modules\game_minimap\minimap.lua bbb

3) Add shop v8 server-side

image
test in clean version otc and tfs 1.5 8.6

kokekanon added 14 commits July 3, 2024 14:28
example attachParticleEffect: g_game.getLocalPlayer():attachParticleEffect("creature-effect") 	modules\game_attachedeffects\attachedeffects.lua
delete unnecessary print
print("No stats bars dimensions found: ", dimension, " on reloadCurrentTab()")	modules\game_interface\widgets\statsbar.lua
Add comment to minimap tfs c++ (old) :
void ProtocolGame::sendWorldTime()
tfs lua (new) :
function Player.sendWorldTime(self, time)
Canary:
void ProtocolGame::sendTibiaTime(int32_t time`) 	modules\game_minimap\
test in clean version otc and tfs 1.5 8.6
@kokekanon kokekanon changed the title improve: Readme improve: Readme + Add comments + Add shop v8 server-side Jul 3, 2024
Copy link
Contributor

@matheussf matheussf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This new readme with gifs/videos for context is insane, thanks!
Awesome work!

@mehah
Copy link
Owner

mehah commented Jul 4, 2024

@kokekanon

current:
image

new readme (fix)
image

NICE WORK!!! 💗

@majestyotbr majestyotbr changed the title improve: Readme + Add comments + Add shop v8 server-side improve: readme infos Jul 4, 2024
@mehah
Copy link
Owner

mehah commented Jul 4, 2024

@kokekanon

If you find it necessary, you can clean up the features, there are many things that are unnecessary to inform and only make it more polluted.

type: c++20, Optimized Terminal, Idle Animation Support, Some bugs fixed contained in edubart/otclient etc...

you can replace it with text saying this client contains XYZ optimizations compared to otc edubart,

Unfortunately, I'm terrible at this, if not, it would help you to describe it.

@kokekanon
Copy link
Collaborator Author

kokekanon commented Jul 4, 2024

Like this?
there are several of your videos on youtube in the otland post, which I can put there, along with a brief description.

image


drop-down menu

asi

moved to drop-down menu :

  • C++20
  • Floor Shadowing

delete :

  • Crosshair
  • Optimized Terminal
  • Some bugs fixed contained in edubart/otclient
  • Idle Animation Support

Posible delete? or moved to drop-down menu ?:

  • Floating Effects Option ,
  • Refactored Walk System

@mehah
Copy link
Owner

mehah commented Jul 4, 2024

@kokekanon
yeap :)

@mehah
Copy link
Owner

mehah commented Jul 17, 2024

@kokekanon

I think it's better to put Support HTML/CSS syntax, because it doesn't support all the features of html/css.

Video.Sem.Titulo.Feito.Com.O.Clipchamp.1.mp4

There's this video too if you want to post it.

@leoddias
Copy link
Contributor

leoddias commented Aug 1, 2024

@kokekanon Awesome work!

@kokekanon
Copy link
Collaborator Author

@kokekanon kokekanon marked this pull request as ready for review August 8, 2024 21:26
@luanluciano93 luanluciano93 requested a review from matheussf August 9, 2024 05:03
Copy link
Contributor

@matheussf matheussf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Just a quick suggestion for better Git flow in future PRs: it might be more effective to keep PRs smaller and focused on specific contexts. For example, in this case, you could have one PR for the readme.txt and another for the shopSERVER. Working on each task separately and opening individual PRs for each would make the review process less tedious and time-consuming. Using Git Flow could be a good approach—create a branch for the feature and then merge the sub-tasks into this feature branch.

@mehah mehah merged commit 213b315 into mehah:main Aug 9, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants