diff --git a/README.md b/README.md index ade13d3..c0d82bf 100644 --- a/README.md +++ b/README.md @@ -18,3 +18,7 @@ Vivaldi, make sure that you have all modifications disabled.** - [Installation](using-mods/installation.md)—*I’ve got some code, what to do with it?* - Advanced +- Community + - [Asking Questions](community/asking-questions.md)—*Where can I get help?* + - [Sharing Mods](community/sharing-mods.md)—please do not keep your mods for + yourself! diff --git a/assets/community/asking-questions/post-as-question.png b/assets/community/asking-questions/post-as-question.png new file mode 100644 index 0000000..b02d37e Binary files /dev/null and b/assets/community/asking-questions/post-as-question.png differ diff --git a/assets/community/sharing-mods/edit-post.png b/assets/community/sharing-mods/edit-post.png new file mode 100644 index 0000000..ee82216 Binary files /dev/null and b/assets/community/sharing-mods/edit-post.png differ diff --git a/assets/community/sharing-mods/tag-post.png b/assets/community/sharing-mods/tag-post.png new file mode 100644 index 0000000..fd88ef5 Binary files /dev/null and b/assets/community/sharing-mods/tag-post.png differ diff --git a/community/asking-questions.md b/community/asking-questions.md new file mode 100644 index 0000000..766f167 --- /dev/null +++ b/community/asking-questions.md @@ -0,0 +1,35 @@ +# Asking Questions on the Forum + +Author(s): code3z (code3) + +The [modding forum](https://forum.vivaldi.net/category/52/modifications) +is a great place to ask questions about modding. Before asking, search the +forum and the internet to check if there is not already a good answer. + +When asking a question, keep a few simple things in mind: + +- Use a topic title that is descriptive +- Be polite and don’t use ALL CAPS +- If you are asking questions about a certain piece of code, share that code +- Share any ways you thought might fix the problem even if they didn’t work +- Don’t add the “mod” or “modding” tags to your post—save that for when you + actually publish a mod + +## Asking for Mods + +You can use the forum to ask someone to make a mod for you. But remember that it +is a big favor: if they wanted this mod themselves, they would have almost +certainly made it. So be patient, describe what you’re looking for clearly, and +realize that you may not get an answer at all (especially if what you’re asking +is hard to do). + +If you think that what you’re asking for should be implemented in Vivaldi +directly, remember to make a feature request for it in the [correct section of +the forum](https://forum.vivaldi.net/category/113/feature-requests). + +## Posting As A Question + +Please use the drop-down menu next to the “Submit” button to mark your post +as a question, like this: + +![](../assets/community/asking-questions/post-as-question.png) diff --git a/community/sharing-mods.md b/community/sharing-mods.md new file mode 100644 index 0000000..c3a227e --- /dev/null +++ b/community/sharing-mods.md @@ -0,0 +1,87 @@ +# Sharing your Mods + +Author(s): code3z (code3) + +The [modding forum](https://forum.vivaldi.net/category/52/modifications) will be +extremely helpful for learning how to mod and getting mods from others. You will +need a [Vivaldi account](https://login.vivaldi.net) to post there. You might +also want a GitHub and/or GitLab account as another way to share your mods. + +--- + +Once you’ve created a mod that you’re proud of, the next step is to share it. +Sharing will be a big help to other people. You can also get feedback and help +from the community. But it will also mean you have to respond to bugs in your +code and help other people use your code. + +## Managing and Sharing Mods using Git + +You can use Git repository hosting services such as GitHub and GitLab to upload, +manage, share, and collaborate on mods. See the Managing Mods guide for more +information on Git. + +## Code Headers + +Putting a comment at the top of your code helps people understand it, use it, +and remember where it came from. Consider using a header like this: + +```css +/** + * + * https://forum.vivaldi.net/topic/<topic> + * Description: <description> + * <if your description is long, continue it here> + * Filename: <filename> + * Platform: <All/Linux/Mac/Windows> + * Version: Vivaldi version <version> + * Author(s): <forum/GitHub/GitLab username, contributors> +**/ +``` + +### Versioning Your Mods + +Instead of versioning your mods separately, it’s easier and sometimes more +helpful to include the latest version of Vivaldi that it was tested in. Along +with the last update time and version history (shown by Git or the forum), this +will let you and others know how up-to-date the mod is. + +If you do want to version your mods, please include the Vivaldi version as well. + +## Posting Mods to the Forum + +### Tagging Forum Posts + +Tagging your mods helps others find them. Use the forum tagging feature to +insert the following tags, in addition to any others that make sense: + + 1. [Modding] + 2. [CSS] and/or [JavaScript] + 3. [Area]—what area of the UI does it affect? + +If the tag doesn’t exist, the forum software will create it—but please **don’t +make new tags** on your own! Only use tags that are suggested from the +drop-down. + +![Tagging Posts Screenshot](../assets/community/sharing-mods/tag-post.png) + +## Describing Your Mods + +Now that you’ve added your code, titled your post, and tagged it, you need to +write content! What you write is really up to you, but be sure to include what +the mod does, how it will help people, and if it has any shortcomings or bugs +or if it does not work with certain settings. + +You should also **include a screenshot**. If the mod does something that can +only be shown through a screen recording, take a screen recording and upload +it as a GIF. You can find some screen recording tools in the resources section +of this guide. + +Good job, I hope to see your mods soon! 👍 + +## Editing Posts + +To edit a post and update the code, click the three-dot menu. Alternatively, if +using Git or cloud storage, just link to the file and don’t worry about +updating your post each time. + +![Editing Post Screenshot](../assets/community/sharing-mods/edit-post.png)