VLC add-on for real-time media censorship according to user personal settings, using CNSR file format.
This add-on censors categories like nudity, verbal abuse, violence and alchohol and drug consumption. The add-on is also available here.
This add-on is inspired by MEDERI's "Time v3.2" vlc extension.
Supported OS: Windows, Linux and Mac OS.
If you don't have VLC installed on your computer, install it now from VLC
download the repository: press on the "CODE" green button, and choose the option: "Download zip".
Using the installation file (currently only available for Mac OS):
python3 scripts/install.py
, you'll need to enter your administer's passwordcnsr_intf.lua
that points to cnsr-vlc-viewer-addon/intf/cnsr_intf.lua
will be created in /Applications/VLC.app/Contents/MacOS/share/lua/intf
. Every change that will be made in cnsr-vlc-viewer-addon
will be also made to the installed extension.If you want the add-on to be available for all the users of the
computer, access the lua
folder using these paths:
%ProgramFiles%\VideoLAN\VLC\lua
%ProgramFiles (x86)%\VideoLAN\VLC\lua
/usr/lib/vlc/lua
or use the command find /usr/lib -iname VLSub.luac
to find the directory /Applications/VLC.app/Contents/MacOS/share/lua
lua
folder using these paths:%APPDATA%\VLC\lua
~/.local/share/vlc/lua
/Users/%your_name%/Library/Application Support/org.videolan.vlc/lua
Extract the contents of the cnsr-vlc-viewer-addon-main
directory within the downloaded zip file into the lua
folder.
Start the Extension in VLC menu
View > cnsr
for Windows/Linux.VLC > Extensions > cnsr
for Mac OS.Choose your password and your password's hint, please choose a password you will remember and your child will not know. Click save to set the cnsr interface script as an extra interface.
Restart VLC
Start the Extension again in VLC menu
View > cnsr
for Windows/Linux.VLC > Extensions > cnsr
for Mac OS.Configure the cnsr categories to your liking.
CNSR files are not created automatically, they must be downloaded or created manually
(in the future a tagging tool will be available)
by watching the video and writing tags with time-stamps.
Possible tags:
You can see an example of a cnsr file here
In order to make use of cnsr file you need to create a new file with the format as shown in example/example_file.cnsr
.
The file name must be identical to the video name you want to play (except for the file type), and must be at the same directory as the video.
For example, if the video you want to play is:
/foo/bar/myvid.mp4
Then the cnsr file should be:
/foo/bar/myvid.cnsr
To work conveniently with git, we recommend cloning the project in your exsisting lua folder.
Since git doesn't allow to clone a project into an existing folder, we reccomend following these steps:
If you don't have VLC installed on your computer, install from VLC
If you don't have Git installed on your computer, install from Git
Open a terminal\CLI with admin privileges:
WinKey + x > a
and approve UAC.ctrl + alt + t
, type sudo -i
and enter password if necessary.cmd + space >
, type terminal
type sudo -i
and enter password if necessary.Type cd "<lua path>"
(find lua path
according to section 3 of "Installing the add-on for regular use").
type git init
type git remote add origin https://github.com/ophirhan/cnsr-vlc-viewer-addon.git
type git fetch origin
type git checkout -b main --track origin/main
And that's it! the add-on is installed, and you are ready to start developing.
ctrl + m
or command + m
If you're just getting started with lua, here are some important things that set it apart from other programming languages:
For more on lua this tutorial will help you get up and running in little to no time.
If you are not an approved collaborator, changing and pushing to the main branch is not possible, in order to contribute to our code you'll need to: