README file from
GithubOxill Calendar — Obsidian calendar, schedules and status tracker
English · Русский
Oxill Calendar is an Obsidian calendar plugin for daily notes, weekly notes, monthly notes, recurring schedules, shift planning, project planning and day status tracking. It is useful for 5/2 and 2/2 work schedules, rotating shifts, personal projects, workouts, study plans, habits and other recurring routines.
The plugin works locally inside your Obsidian vault. It contains no telemetry and does not send notes or settings to external services.
Features
- monthly calendar in the Obsidian sidebar;
- daily, weekly and monthly periodic notes;
- optional daily note templates for each weekday;
- configurable Monday or Sunday week start;
- fixed
YYYY-MM-DDfilenames for calendar notes; - optional connection to existing daily notes by filename or a date property;
- separate folders and templates for every calendar-note type;
- searchable folder and Markdown template path suggestions;
- customizable corner, overline or underline indicators for days with existing notes;
- separate calendar number colors for light and dark themes;
- up to four independent recurring schedules;
- ordered weekly periods with an individual start date;
- hours for every weekday and a pastel color for every period;
- multiple schedules displayed as colored sectors on the same calendar day;
- schedule colors shown as outlines or full fills;
- per-day period selection and schedule disabling from the context menu;
- period changes and schedule disabling over a selected date range;
- optional hiding of dates outside the displayed month;
- schedule archiving that preserves calendar history;
- unlimited custom statuses;
- up to three colored status dots on each day;
- optional black outlines around status dots;
- status assignment from the date context menu;
- bulk status assignment across a date range with a configurable interval;
- removal of status assignments from a date range or the entire calendar;
- optional work-period timer with start, pause and stop controls;
- a sidebar inbox for describing active and completed work periods;
- searchable Markdown work report templates written to the daily note footer;
- selectable Russian or English interface;
- light and dark themes, desktop and mobile support.
Use cases
Use Oxill Calendar as an Obsidian shift work calendar, rotating schedule calendar, project calendar, daily status tracker, productivity planner or periodic notes calendar. Separate schedules can represent work, workouts, study and personal projects, while colored statuses can mark cooking, cleaning, training or any completed routine.
Installation
Manual installation
- Download
main.js,manifest.jsonandstyles.cssfrom the latest release. - Create
<your vault>/.obsidian/plugins/oxill-calendar/. - Copy the three downloaded files into that directory.
- Restart Obsidian and enable Oxill Calendar under Settings → Community plugins.
BRAT installation
Add oxilldat/oxill-calendar to BRAT, install the plugin and enable it in Obsidian.
Quick start
- Open Settings → Oxill Calendar.
- Configure periodic note folders and templates.
- Create a schedule, add periods and enter hours for each weekday.
- Create custom statuses with names and colors.
- Click a date to open its note or right-click it to assign statuses.
To track work sessions, enable Work periods in the plugin settings and select a Markdown report template. The side panel supports two simultaneous timers and reports without a timer, with a separate template for untimed entries. Pauses are included in {{duration}}; use {{workDuration}} and {{pauseDuration}} to show work and pause time separately. Add a description during or after the session, then save the report to the corresponding daily note.
A fresh installation contains no schedules, statuses or user data. Everything is created locally in the settings of the current vault.
Development
Node.js 24+ and npm are required.
npm ci
npm run check
npm run build
Credits and license
Oxill Calendar is maintained by Oxill and is based on Calendar 1.5.10 by Liam Cain. See FORK.md for attribution. The source code is available under the MIT License.