
--- RegionCap - version 0.9 ---

	RegionCap is a simple tool for recording a video from a part of your screen.

	RegionCap is provided for free.
	Do not trust anyone who tries to sell RegionCap.
	See https://sundee.neocities.org/ for updates and other programs.

	This program is for Windows only. Tested on Windows 7 only.
	Linux version may or may not happen in the future.
	Mac version never.


--- Installation ---

	RegionCap requires an external program: FFmpeg. You can either install it onto your computer,
	or put the executable (ffmpeg.exe) into the same folder as this file.

	Option 1: get my executable pack
		1. Download "FFmpeg" from https://sundee.neocities.org/regioncap
		2. Extract the .zip file
		3. Put ffmpeg.exe, into the same folder as this file
		Note: you do not need to click the files, just leave them in there.

	Option 2: download and/or install the required file to your computer
		https://ffmpeg.org/download.html#build-windows


	-- Why the separate program? --

		FFmpeg is a tool for processing video and audio. It is basically impossible for a single
		developer (me) to do it competently due to how complex things related to videos are.

	-- Why is it in a separate download? --

		Because it's huge. FFmpeg is about 200 times bigger than RegionCap, it's annoying to
		upload/download/archive them. Also you may have FFmpeg already installed, in which case
		you don't need them.


--- How to fix audio if it isn't working ---

	FFmpeg cannot record audio automatically, so you may have to manually select the audio device
	that you want to to record.

	1. Run 'list_audio_devices.bat' by double clicking it.
	2. A text window should popup, somewhere in it should be an audio device. Look for the text
		"(audio)", the name you want is right before it, for example the name might be:
		"Stereo Mix (Realtek High Defini". The name may look like it's been cut off halfway,
		that's fine.
	3. Open "config.txt", find "audio_device" and type your audio device name after it.
	4. Restart RegionCap if you had it open.


	-- There was no audio devices / it doesn't work! --

		"Could not enumerate audio only devices (or none found)."

		If you get an error like this, or if the audio still doesn't work, you may need to find your
		Windows audio settings and enable a different Recording device. There may be several, usually
		you'll want to enable one of the devices that says "Stereo Mix". Try them one by one until you
		find one that works.

		Note that your desktop volume will affect the recorded audio loudness, so make sure that the
		audio isn't simply very quiet.

		If it still doesn't work, then I dunno how to fix it. You can still record muted videos by
		turning off audio.

	-- The audio isn't in sync with the video / there's a delay! --

		You will have to fix it yourself with a different program.


--- Usage ---

	-- Buttons from left to right --
	
		Record button = click this to start recording.
		
		1 = Hide crop frame (note: the frame is only visual, it does not show up in the recording)
		2 = Show minimal crop frame
		3 = Show full-screen crop frame
		Lock = Lock the crop frame, this prevents you from resizing the crop frame.
		
		Cursor = if enabled, your mouse cursor will show up in the recording.
		Speaker = record audio.
		
		FPS = what framerate to record at. Lower framerate will result in a smaller filesize,
			higher framerate will result in smoother video.
		
		Delay = when you click the record button, there will be a delay (in seconds) before the
			recording starts. Set to 0 to start recording immediately.
		
		Folder = open the folder where the recording goes to.
		
		Move = move window.
		Minimize = minimize window.
		X = close window.

	-- Compressing the video --

		RegionCap records a lossless video, which can make the video file size very large. To
		compress it, simply drag it on top of the file called "compress_video.bat".

		You can open the compress_video.bat in a text editor to modify it. Changing the CRF value
		lets you increase the video quality or lower the file size.


--- Other notes/trivia ---

	This program was written in plain C. stb_image library is used to load image files, and
	stb_truetype library is used to handle font files.
	https://github.com/nothings/stb

	RegionCap is just a frontend for FFmpeg, which is what does the actual recording.
