Documentation

Customizing

There are four main ways in which you can modify FluxBB v1.4. The first three, styles, language packs, and plugins, simply require dropping a file or folder into the right directory. Modifications however often involve modifying the core files, and hence are harder to install and remove.

Styles

Styles are packages that can be used to alter the look and feel of your forum. They can be downloaded from our repository.

A style should consist of 1 CSS file named <style>.css, and (optionally) a folder named <style> containing any required templates, images etc. (where <style> is the name of the style).

To install a style simply upload the CSS file and, if it exists, the corresponding folder, into the /style/ folder inside your forum root directory.

Once installed the style will be available within the administration console to set as the forum default, as well as within everyone's profile allowing them to use it if they wish.

For information on developing your own style, please see the developing styles section of the developer wiki.

Language packs

Language packs are used to translate your forum into a different language. They can be downloaded from our repository.

A language pack should consist of 1 folder named after the language it contains. It should contain a number of *.php files which contain the actual translation strings. It should also contain a stopwords.txt file, which contains a list of words which should not be indexed by the search engine, and a folder called mail_templates which includes translated versions of certain emails FluxBB can send.

To install a language pack simply upload the folder into the /lang/ folder inside your forum root directory.

Once installed the language will be available within the administration console to set as the forum default, as well as within everyone's profile allowing them to use it if they wish.

For information on developing your own language pack, please see the developing translations section.

Plugins

Plugins allow you to add features to your administration panel. While modifications allow you to add features to the actual forum core or modify its behaviour, you cannot do the same with plugins. However, they offer benefits like simplifying typical administrator tasks or providing additional features that FluxBB cannot and will not provide (due to its philosophy).

Another benefit of plugins is that they are very easy to install. All you have to do is drop the plugin file into the directory /plugins/ and you can immediately start using it.

Some plugins are restricted to administrator access, while others may be used my moderators, too. You can discern the two types by their filenames: plugins that start with AMP_ can be used my moderators, too, while those that start with AP_ cannot.

For information on developing your own plugin, please see the developing plugins section.

Modifications

Modifications allow you to modify FluxBB's core or add features to it. While they are very flexible, because basically everything can be altered, they are also very prone to errors. They can be harder to apply and make it harder to update your forum.

Modifications can be found at the resources section. All packages have installation instructions and exactly explain how the modification should be installed.

For information on developing your own modification, please see the developing modifications section.