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

Document how to cycle colors #79

Open
wants to merge 1 commit into
base: site
Choose a base branch
from

Conversation

KronosTheLate
Copy link

This PR adds a skeleton for a sentence I am missing before i can make use of ColorCycle, where i am hoping that someone who knows the answer can correct the part in all caps. Alternativly, linking to some documentation would be great.

This PR adds a skeleton for a sentence I am missing before i can make use of ColorCycle, where i am hoping that someone who knows the answer can correct the part in all caps. Alternativly, linking to some documentation would be great.
@rolandlo
Copy link
Member

It's <Alt>+c according to the code:
https://github.com/xournalpp/xournalpp/blob/2809cb4fd1ce20723be688421f54223602ed22bf/plugins/ColorCycle/main.lua#L3
You can use any other accelerator by changing that line. As for documentation, this section on the website is relevant.

@KronosTheLate
Copy link
Author

That is an excellent answer, and I have NO idea where i could easily find that information other than looking up the structure of the Lua files for a general purpose, which I am not interested in. Thanks for the reply ^_^

Should a general recipe like you outlined (inspecting the .lua file) be included at the top of the section?

@rolandlo
Copy link
Member

In general before executing any scripts/plugins it is highly recommended to take a look what it does. For two reasons:

  1. security (a hacker could have modified the script/plugin in a way that it executes malware)
  2. you may want to make some modifications, so that it satisfies your needs. This is easy for a Lua plugin (where you can just adjust a line or a couple of lines and don't need to compile anything) in comparison with the C++ codebase (where you first need to setup the whole system so you can compile the project and then you have to find one or more of hundreds of source files, where you need to make changes)

Maybe we should add a comment in that direction to the website.

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.

None yet

2 participants