Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
02f8d3c
First Commit for "Sharing"
May 26, 2021
b36bad4
tiosgz suggestions
May 26, 2021
c5a919c
More! Including rename forum -> community
May 26, 2021
fc0bc3e
Added Git and Fixes
May 28, 2021
ef9d9f1
Various updates
May 29, 2021
bec4fdd
Recommended Changes
May 30, 2021
37d42ab
More Recommended Changes
May 30, 2021
f887b11
Git
May 30, 2021
0923c87
Small fix
May 30, 2021
48fe6bd
Screenshots
May 30, 2021
3cda841
Screenshots in Markdown
May 30, 2021
398494c
Do the asterisk the "right way"
May 30, 2021
1039272
Fix: Guidelines and best Practices, Phrasing
Jun 1, 2021
2a43bac
README resolve conflicts
code3z Jun 2, 2021
6de4fae
Fix: Keep all lines under 90 char (and aim for 80 char)
Jun 2, 2021
acbce6d
Fix: Correct a few lines
Jun 2, 2021
412c597
Move: assets/images -> assets/screenshots
Jun 3, 2021
ec68d0e
Even better line spacing!
Jun 3, 2021
f712142
Spacing Update community/sharing.md
code3z Jun 5, 2021
f580909
“Cloud Storage” Update community/sharing.md
code3z Jun 5, 2021
8410062
Capitalization Update community/asking-questions.md
code3z Jun 5, 2021
5293ec5
May -> Will Update community/sharing.md
code3z Jun 5, 2021
bf39065
Remove three dashes
code3z Jun 5, 2021
574c998
Versioning Wording Update community/sharing.md
code3z Jun 5, 2021
46a1d77
Less Verbose Update community/sharing.md
code3z Jun 5, 2021
1700234
Update community/asking-questions.md
code3z Jun 5, 2021
13d9bc5
Update community/sharing.md
code3z Jun 5, 2021
9e30257
Merge branch 'master' of https://github.com/tiosgz/modding-vivaldi in…
Jun 5, 2021
b7a9e13
git push origin sharing
Jun 5, 2021
06e14af
Add non-conflicting README
Jun 5, 2021
3ae8e27
Merge branch 'sharing' of https://github.com/code3z/modding-vivaldi i…
Jun 5, 2021
5483857
Minor changes
Jun 5, 2021
8f5420c
Long Lines
Jun 5, 2021
0d6317d
More minor Changes
Jun 6, 2021
2de92bd
More minor changes, including images
Jun 6, 2021
efabe8d
Better README
Jun 6, 2021
f66d57c
Fixes & high-priority suggestions
Jun 10, 2021
d3b8daa
Suggestions
Jun 10, 2021
ce87d2c
(don't) read me
Jun 10, 2021
ed2ee45
Assets paths fix
Jun 10, 2021
5018df0
(don't) read me again
Jun 10, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/community/sharing-mods/edit-post.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/community/sharing-mods/tag-post.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 35 additions & 0 deletions community/asking-questions.md
Original file line number Diff line number Diff line change
@@ -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)
87 changes: 87 additions & 0 deletions community/sharing-mods.md
Original file line number Diff line number Diff line change
@@ -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
/**
* <title>
* 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)