final changes for new release

Author: ColumPaget

README.md

@@ -181,15 +181,17 @@ Icons are only currently supported for the JWM and IceWM window managers. Icons
 Config File
 -----------
 
-The config file has three types of entry
+The config file has the following types of entry
 
 1) app entries
-App entries describe programs that can be added to menus. They have the form:
+App entries describe programs that lack .desktop files. They have the form:
 
 ```
-	app [programfile] group=[group] icons=[icon names] title=[title] invoke=[invocation]
+	app [name] group=[group] icons=[icon names] title=[title] invoke=[invocation]
 ```
 
+'name' will be the filename on disk for this program.
+
 'group' is the application group, or submenu that this item belongs in. 'title' is the name that will be displayed in the menu. 'icons' is a comma-separated list of icon names that could be used as an icon for this app (menubuilder will search for files matching [icon name].png, [icon name].jpg etc). 'invocation' is the full command-line used to run the app. The icons, title and invoke arguments are optional.
 
 For example:
@@ -228,6 +230,13 @@ Override entries are app entries that mostly apply to apps discovered via .deskt
 	override DesktopDungeons group=Roguelike icons=skull,sword,goblin
 ```
 
+Override entries have a special feature where multiple apps can be specified as a comma-separated list, and the same config applied to them, like so:
+
+```
+override Helm,PHASEX,IanniX,QMidiArp,Qtractor,drumkv1,samplv1,padthv1,synthv1,amsynth group=Music
+```
+
+
 3) group entries
 
 group entries apply settings to a menu subgroup, for example:
@@ -237,3 +246,19 @@ group entries apply settings to a menu subgroup, for example:
 ```
 
 The 'parent' option specifies that this is not a top-level group, but is a subgroup of the group 'games'
+
+Some groups are discovered from the "Categories" entry in .desktop files. Such entries are normally a list of groups seperated by semi-colons. menubuilder.lua picks the first of these groups, but this is not always useful. You can ignore groups with the 'ignore' qualifier:
+
+```
+group KDE ignore
+```
+
+This will have the effect that this group will not be added to the menu, and that applications belonging to this group will be booked against the first group in their "Categories" entry that isn't ignored.
+
+4) 'ignore' entries
+
+'ignore-groups' and 'ignore-apps' can be used to more conviniently list items to be ignored, like so:
+
+```
+ignore-groups GTK,Gtk,Qt,Application,ConsoleOnly,GNOME,SDL
+```

menubuilder.conf

@@ -1,11 +1,6 @@
-iconset CrystalRemix https://github.com/dangvd/crystal_remix/archive/v1.0.tar.gz
-iconset Delft https://github.com/madmaxms/iconpack-delft/releases/download/v1.11/delft-iconpack.tar.xz
-iconset Oxygen https://github.com/KDE/oxygen-icons/archive/master.zip
-iconset FatCow https://www.fatcow.com/images/fatcow-icons/fatcow-hosting-icons-3.9.2-all.zip
 
 #a list of group names to ignore if they occur in .desktop files
-ignore-groups GTK,Gtk,Qt,Application,ConsoleOnly,GNOME
-ignore-apps Arcade
+ignore-groups GTK,Gtk,Qt,Application,ConsoleOnly,GNOME,SDL
 
 group Audio icons=Speaker,sound,audio-speaker,Music 
 group AudioVideo icons=television,film
@@ -45,18 +40,20 @@ override DesktopDungeons group=Roguelike
 override GemSwap group=Puzzle
 override SegaSwirl group=Puzzle
 override Invaders95 group=ArcadeClassics
-override Helm group=Music
-override PHASEX group=Music
-override IanniX group=Music
-override QMidiArp group=Music
-override Qtractor group=Music
-override QtFM group=FileManager
+
+override Helm,PHASEX,IanniX,QMidiArp,Qtractor,drumkv1,samplv1,padthv1,synthv1,amsynth group=Music
+override Cutegram,Quaternion,nheko,KVIrc group=Chat
+override QtFM,worker group=FileManager
+override Vim,GVim,FeatherPad group=TextEditor
+override Evilvte,LilyTerm,LXTerminal group=TerminalEmulator icons=terminal,xterm 
+
 override HTop group=System termapp
 override Galculator group=Calculator
-override Cutegram group=Chat
-override Quaternion group=Chat
 override QupZilla group=WebBrowser
-override Evilvte group=TerminalEmulator icon=terminal,xterm 
+
+#this app is triggered off a shortcut key, not by being run as normal, but it has a .desktop file
+#so we ignore it
+override Stjerm ignore
 
 # These are special apps used to query information for apps that expect to have it passed to them
 # on the command-line
@@ -66,15 +63,12 @@ app xdialog group=DialogApp
 
 app aterm group=TerminalEmulator icon=xterm,terminal title="aterm"
 app xterm group=TerminalEmulator icon=xterm,terminal title="Xterm"
-app lxterminal group=TerminalEmulator icon=xterm,terminal title="LXterminal"
 app mrxvt group=TerminalEmulator icon=urxvt,terminal,xterm 
 app urxvt group=TerminalEmulator icon=terminal,xterm
 app st group=TerminalEmulator icon=xterm,terminal title="Suckless Terminal"
 app qterminal group=TerminalEmulator icon=terminal,xterm title="Qterminal"
 app gnome-terminal group=TerminalEmulator icon=terminal,xterm title="GNOME Term"
 app konsole group=TerminalEmulator icon=terminal,xterm title="Konsole"
-app lilyterm group=TerminalEmulator icon=terminal,xterm 
-app stjerm group=TerminalEmulator icon=terminal,xterm 
 app gtkterm group=TerminalEmulator icon=terminal,xterm 
 app gtkterm2 group=TerminalEmulator icon=terminal,xterm 
 app vte group=TerminalEmulator icon=terminal,xterm 
@@ -165,7 +159,6 @@ app krayon group=Graphics icon=art,picture
 app tuxpaint group=Graphics icon=art,picture title="Tux Paint"
 app mtpaint group=Graphics icon=art,picture title="Mt Paint"
 app qiv group=Graphics icon=pencil,art,picture title="Quick Image Viewer"
-app phototonic group=Graphics icon=pencil,art,picture title="Phototonic Viewer"
 app tuxpaint group=Graphics icon=pencil,art,picture
 app SimplePaint group=Graphics icon=pencil,art,picture title="Simple Paint"
 app grafx2 group=Graphics icon=pencil,art,picture title="GraFX2 Pixel Editor"
@@ -247,8 +240,7 @@ app jed group=TextEditor icon=editor,pencil
 
 app bluefish group=TextEditor icon=editor,pencil 
 app leafpad group=TextEditor icon=editor,pencil 
-app featherpad group=TextEditor icon=feather,editor,pencil title="Feather Pad"
-app geany group=TextEditor icon=feather,editor,pencil 
+app geany group=TextEditor icon=editor,pencil 
 app kwrite group=TextEditor icon=editor,pencil
 app gedit group=TextEditor icon=editor,pencil
 app kedit group=TextEditor icon=editor,pencil
@@ -286,12 +278,10 @@ app dischord group=Chat icon=chat
 app qTox group=Chat icon=chat title="qTox"
 app utox group=Chat icon=chat title="uTox" invoke='LD_PRELOAD="" utox'
 app LuxIRC group=Chat icon=chat title="Lux IRC"
-app kvirc group=Chat icon=chat title="KV IRC"
 app tensor group=Chat icon=chat title="Tensor Matrix Chat"
 app Slacken group=Chat icon=chat 
 
-app cherrytree group=Notes icons=note,stickynote,feather,notepad 
-app feathernotes group=Notes icons=note,stickynote,feather,notepad title="Feather Notes"
+app cherrytree group=Notes icons=note,stickynote,notepad 
 app notes group=Notes icons=note,stickynote,notepad title="Qt Notes"
 app noblenote group=Notes icons=note,stickynote,notepad title="Noble Note"
 
@@ -331,8 +321,6 @@ app dvbcut group=AudioVideo icons=media,video title="DVB cut"
 app kaffine group=AudioVideo icons=media,video 
 app llms group=AudioVideo icons=media,video title="LLMS"
 app ogmrip group=AudioVideo icons=media,video title="OGM rip"
-app smtube group=AudioVideo icons=media,video title="SM Tube"
-app smplayer group=AudioVideo icons=media,video title="SM Player"
 app sinek group=AudioVideo icons=media,video title="Sinek Player"
 app realplay group=AudioVideo icons=media,video title="RealPlayer"
 app vlc group=AudioVideo icons=wmplayer,media,video title="VLC"

menubuilder.lua

@@ -28,22 +28,22 @@ end
 function ProcessAppOverrides(app)
 local name, config
 
-config=overrides_config[app.exec]
+config=overrides_config[app.name]
+if config == nil then config=overrides_config[app.exec] end
 if config ~= nil 
 then
 	if strutil.strlen(config.group) > 0 then app.group=config.group end
-	if strutil.strlen(config.name) > 0 then app.name=config.name end
 	if strutil.strlen(config.icon) > 0 then app.icon=config.icon end
-	if strutil.strlen(config.query) > 0 then app.query=config.query end
 	if config.termapp == true then app.termapp=true end
-	if config.ignore == true then app.igore=true end
+	if config.ignore == true then app.ignore=true end
+	if config.query == true then app.query=true end
 end
 
 end
 
 
 
-function NewApp(source, name, exec )
+function NewApp(source, name, exec)
 local app={}
 
 app.type="app"
@@ -416,6 +416,25 @@ end
 end
 
 
+function LoadOverrides(app_config)
+local app, toks
+
+	app=LoadAppConfig(app_config)
+	if app ~= nil 
+	then 
+		--Overrides have one difference from normal app configs, that multiple app names
+		--can be specified seperated by commas. Thus we can apply the same override to many apps
+		toks=strutil.TOKENIZER(app.exec, ",")
+		str=toks:next()
+		while str ~= nil
+		do
+		overrides_config[str]=app 
+		str=toks:next()
+		end
+
+	end
+end
+
 
 function LoadConfig()
 local S, str, app, entry_type
@@ -455,8 +474,7 @@ then
 				LoadIgnoreApps(toks:remaining())
 			elseif entry_type=="override"
 			then
-				app=LoadAppConfig(toks)
-				if app ~= nil then overrides_config[app.exec]=app end
+				LoadOverrides(toks)
 			elseif entry_type=="app"
 			then
 				app=LoadAppConfig(toks)